@cognigy/rest-api-client 0.9.1 → 0.12.0

package/build/shared/charts/descriptors/data/log.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOG = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+/**
+ * Node name: 'Log'
+ *
+ * Purpose:
+ * Writes a message to the Agent Logs
+ */
+exports.LOG = createNodeDescriptor_1.createNodeDescriptor({
+    type: "log",
+    defaultLabel: "Log Message",
+    summary: "Writes a message into the agent logs",
+    appearance: {
+        showIcon: false
+    },
+    fields: [
+        {
+            key: "message",
+            type: "cognigyText",
+            label: "Message",
+        },
+        {
+            key: "level",
+            type: "select",
+            label: "Log Level",
+            defaultValue: "debug",
+            description: "The level at which to log the message",
+            params: {
+                required: true,
+                options: [
+                    {
+                        label: "Info",
+                        value: "info",
+                    },
+                    {
+                        label: "Debug",
+                        value: "debug",
+                    },
+                    {
+                        label: "Error",
+                        value: "error",
+                    },
+                ]
+            }
+        }
+    ],
+    preview: {
+        key: "message",
+        type: "text",
+    },
+    tags: ["basic", "log", "logging"],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { level, message } = config;
+        if (level && message)
+            api.log(level, message);
+    }
+});
+//# sourceMappingURL=log.js.map

package/build/shared/charts/descriptors/data/removeFromContext.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.REMOVE_FROM_CONTEXT = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**

package/build/shared/charts/descriptors/data/resetContext.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RESET_CONTEXT = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**

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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.END = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../createNodeDescriptor");
 exports.END = createNodeDescriptor_1.createNodeDescriptor({
@@ -8,6 +9,7 @@ exports.END = createNodeDescriptor_1.createNodeDescriptor({
     appearance: {
         color: '#61D188',
         textColor: 'white',
+        contrastTextColor: 'black',
         variant: 'mini'
     },
     constraints: {

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

@@ -1,74 +1,102 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.cognigyVoiceGateway2Module = exports.cognigyMicrosoftModule = exports.cognigyVoiceGatewayModule = exports.cognigySMTPModule = exports.cognigySQLModule = exports.cognigyMongoDBModule = exports.cognigyBasicModule = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../createNodeDescriptor");
 /* Nodes */
 const start_1 = require("./start");
 const end_1 = require("./end");
+const placeholder_1 = require("./placeholder");
 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 service_1 = require("./service");
+const apps_1 = require("./apps");
 // import { REQUIRED_FIELDS } from "./requiredFields";
 // import { ALL_FIELDS } from "./allFields";
+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,
+    //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,
+    nlu_1.FUZZY_SEARCH,
+    nlu_1.MATCH_PATTERN,
+    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.HANDOVER_V2,
+    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_APPS === "true") {
+    nodes.push(apps_1.INIT_APP_SESSION, apps_1.SET_APP_STATE);
+}
+if (process.env.FEATURE_DISABLE_INSIGHTS !== "true") {
+    nodes.push(profile_1.SET_RATING, profile_1.REQUEST_RATING);
+}
+if (process.env.FEATURE_ENABLE_EXTRACT_ANSWER === "true") {
+    nodes.push(nlu_1.EXTRACT_ANSWER);
+}
 exports.cognigyBasicModule = createNodeDescriptor_1.createExtension({
-    nodes: [
-        start_1.START,
-        end_1.END,
-        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,
-        //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,
-        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,
-        service_1.HANDOVER,
-        service_1.HTTP_REQUEST,
-    ],
+    nodes,
     connections: [
         service_1.HTTP_CONNECTION_BASIC,
         service_1.HTTP_CONNECTION_APIKEYAUTHKEY,
@@ -77,9 +105,15 @@ exports.cognigyBasicModule = createNodeDescriptor_1.createExtension({
     ]
 });
 var mongoDB_1 = require("./connectionNodes/mongoDB");
-exports.cognigyMongoDBModule = mongoDB_1.cognigyMongoDBModule;
+Object.defineProperty(exports, "cognigyMongoDBModule", { enumerable: true, get: function () { return mongoDB_1.cognigyMongoDBModule; } });
 var sql_1 = require("./connectionNodes/sql");
-exports.cognigySQLModule = sql_1.cognigySQLModule;
+Object.defineProperty(exports, "cognigySQLModule", { enumerable: true, get: function () { return sql_1.cognigySQLModule; } });
 var smtp_1 = require("./connectionNodes/smtp");
-exports.cognigySMTPModule = smtp_1.cognigySMTPModule;
+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; } });
 //# sourceMappingURL=index.js.map

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

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DISABLE_SLOT_FILLERS = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+/**
+ * Node name: 'disableSlotFillers'
+ *
+ * Purpose:
+ * Disables slot fillers
+ */
+exports.DISABLE_SLOT_FILLERS = createNodeDescriptor_1.createNodeDescriptor({
+    type: "disableSlotFillers",
+    defaultLabel: "Disable Slot Fillers",
+    summary: 'Disable Slot Fillers',
+    appearance: {
+        showIcon: false
+    },
+    fields: [
+        {
+            key: "slotFillersToDisable",
+            type: "slotFillerArray",
+            label: "Slot Fillers",
+            description: "Which Slot Fillers to disable"
+        },
+        {
+            key: "reset",
+            type: "toggle",
+            label: "Disable All Slot Fillers"
+        }
+    ],
+    tags: ["nlu"],
+    function: async ({ cognigy, config }) => {
+        const { slotFillersToDisable, reset } = config;
+        const { api, flowReferenceId } = cognigy;
+        let slotFillers = api.getSystemContext("slotFillers");
+        if (slotFillers) {
+            if (reset) {
+                slotFillers[flowReferenceId] = [];
+            }
+            else {
+                slotFillers[flowReferenceId] = slotFillers[flowReferenceId] && slotFillers[flowReferenceId].filter(filler => slotFillersToDisable.indexOf(filler) === -1);
+            }
+        }
+        else {
+            slotFillers = {};
+            slotFillers[flowReferenceId] = [];
+        }
+        api.setSystemContext("slotFillers", slotFillers);
+    }
+});
+//# sourceMappingURL=disableSlotFillers.js.map

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

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENABLE_SLOT_FILLERS = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+/**
+ * Node name: 'enableSlotFillers'
+ *
+ * Purpose:
+ * Enables slot fillers
+ */
+exports.ENABLE_SLOT_FILLERS = createNodeDescriptor_1.createNodeDescriptor({
+    type: "enableSlotFillers",
+    defaultLabel: "Enable Slot Fillers",
+    summary: 'Enable Slot Fillers',
+    appearance: {
+        showIcon: false
+    },
+    fields: [
+        {
+            key: "slotFillersToEnable",
+            type: "slotFillerArray",
+            label: "Slot Fillers",
+            description: "Which Slot Fillers to enable"
+        }
+    ],
+    tags: ["nlu"],
+    function: async ({ cognigy, config }) => {
+        const { slotFillersToEnable } = config;
+        const { api, flowReferenceId } = cognigy;
+        let slotFillers = api.getSystemContext("slotFillers");
+        if (slotFillers && slotFillers[flowReferenceId]) {
+            const flowSlotFillerSet = new Set(slotFillers[flowReferenceId]);
+            slotFillersToEnable.forEach((value) => { flowSlotFillerSet.add(value); });
+            slotFillers[flowReferenceId] = [...flowSlotFillerSet];
+        }
+        else {
+            if (slotFillers === undefined) {
+                slotFillers = {};
+            }
+            slotFillers[flowReferenceId] = slotFillersToEnable;
+        }
+        api.setSystemContext("slotFillers", slotFillers);
+    }
+});
+//# sourceMappingURL=enableSlotFillers.js.map

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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXECUTE_FLOW = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**
@@ -42,6 +43,26 @@ exports.EXECUTE_FLOW = createNodeDescriptor_1.createNodeDescriptor({
             description: "Absorb the executed Flow's Context into the current Context",
         }
     ],
+    sections: [
+        {
+            key: "advanced",
+            label: "Advanced",
+            defaultCollapsed: true,
+            fields: [
+                "parseIntents",
+                "parseKeyphrases",
+                "absorbContext"
+            ]
+        }
+    ],
+    form: [
+        { type: "field", key: "flowNode" },
+        { type: "section", key: "advanced" },
+    ],
+    preview: {
+        key: "flowNode",
+        type: "resource",
+    },
     tags: ["logic"],
     function: async ({ cognigy, config, nodeId: thisNodeId }) => {
         const { flowNode: { flow: flowId, node: nodeId }, parseIntents, parseKeyphrases, absorbContext } = config;

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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.GO_TO = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**
@@ -15,12 +16,8 @@ exports.GO_TO = createNodeDescriptor_1.createNodeDescriptor({
     appearance: {
         showIcon: false,
     },
-    constraints: {
-        placement: {
-            successor: {
-                whitelist: [],
-            },
-        },
+    behavior: {
+        stopping: true
     },
     fields: [
         {
@@ -34,13 +31,100 @@ exports.GO_TO = createNodeDescriptor_1.createNodeDescriptor({
         {
             key: "absorbContext",
             type: "toggle",
+            description: "Absorb the Context of the target Flow into the current Context",
             label: "Absorb Context",
             defaultValue: false
         },
+        {
+            key: "executionMode",
+            type: "select",
+            description: "Go to new Node and continue execution or wait for input",
+            label: "Execution Mode",
+            defaultValue: "continue",
+            params: {
+                options: [
+                    {
+                        label: "Go to Node and continue",
+                        value: "continue"
+                    },
+                    {
+                        label: "Go to Node and wait for Input",
+                        value: "wait"
+                    },
+                ]
+            }
+        },
+        {
+            key: "injectedText",
+            label: "Optional Injected Text",
+            type: "cognigyText",
+            description: "Text to use when continuing the execution. If no text provided, input.text is used.",
+            defaultValue: "",
+            condition: {
+                key: "executionMode",
+                value: "continue"
+            }
+        },
+        {
+            key: "injectedData",
+            label: "Optional Injected Data",
+            type: "json",
+            description: "Data to use when continuing the execution. If no data is provided, input.data is used.",
+            defaultValue: "{}",
+            condition: {
+                key: "executionMode",
+                value: "continue"
+            }
+        },
+        {
+            key: "parseIntents",
+            type: "toggle",
+            label: "Parse Intents",
+            description: "Parse intents in the target Flow",
+            defaultValue: false,
+            condition: {
+                key: "executionMode",
+                value: "continue"
+            }
+        },
+        {
+            key: "parseKeyphrases",
+            type: "toggle",
+            label: "Parse Slots",
+            description: "Parse slots in the target Flow",
+            defaultValue: false,
+            condition: {
+                key: "executionMode",
+                value: "continue"
+            }
+        },
     ],
+    sections: [
+        {
+            key: "advanced",
+            label: "Advanced",
+            defaultCollapsed: true,
+            fields: [
+                "executionMode",
+                "injectedText",
+                "injectedData",
+                "parseIntents",
+                "parseKeyphrases",
+                "absorbContext"
+            ]
+        }
+    ],
+    form: [
+        { type: "field", key: "flowNode" },
+        { type: "section", key: "advanced" }
+    ],
+    preview: {
+        key: "flowNode",
+        type: "resource",
+    },
     tags: ["logic"],
     function: async ({ cognigy, config, nodeId: thisNodeId }) => {
-        const { flowNode: { flow: flowId, node: nodeId }, absorbContext, } = config;
+        const { flowNode: { flow: flowId, node: nodeId }, absorbContext, executionMode, injectedText, injectedData, parseIntents, parseKeyphrases } = config;
         const { api } = cognigy;
         if (!flowId) {
             throw new Error("flowId is required");
@@ -50,12 +134,30 @@ 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);
+                return;
+            }
+            if (injectedText) {
+                cognigy.input.text = injectedText;
+            }
+            if (injectedData &&
+                typeof injectedData === 'object' &&
+                Object.keys(injectedData).length !== 0) {
+                cognigy.input.data = injectedData;
+            }
+            // If Execution is to continue, execute Flow
             await api.executeFlow({
                 flowNode: {
                     flow: flowId,
-                    node: nodeId
+                    node: nodeId,
+                    isGoto: true,
                 },
                 absorbContext,
+                parseIntents,
+                parseKeyphrases
             });
         }
         else {

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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ELSE = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 exports.ELSE = createNodeDescriptor_1.createNodeDescriptor({
@@ -9,12 +10,14 @@ exports.ELSE = createNodeDescriptor_1.createNodeDescriptor({
     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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.IF = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 exports.IF = createNodeDescriptor_1.createNodeDescriptor({
@@ -7,8 +8,9 @@ exports.IF = createNodeDescriptor_1.createNodeDescriptor({
     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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.THEN = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 exports.THEN = createNodeDescriptor_1.createNodeDescriptor({
@@ -9,12 +10,14 @@ exports.THEN = createNodeDescriptor_1.createNodeDescriptor({
     appearance: {
         color: '#B3A7EA',
         textColor: 'white',
+        contrastTextColor: 'black',
         variant: 'mini'
     },
     constraints: {
         editable: false,
         deletable: false,
         collapsable: true,
+        childFlowCreatable: true,
         creatable: false,
         movable: false,
         placement: {},