@cognigy/rest-api-client 0.9.1 → 0.12.0

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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.THINK = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**
@@ -10,33 +11,96 @@ const createNodeDescriptor_1 = require("../../createNodeDescriptor");
  */
 exports.THINK = createNodeDescriptor_1.createNodeDescriptor({
     type: "think",
-    defaultLabel: "Think",
+    defaultLabel: "Think Legacy",
     summary: "Restarts Flow execution with a customized message",
     appearance: {
-        showIcon: false
+        showIcon: false,
+    },
+    constraints: {
+        placement: {},
+        creatable: false,
     },
     fields: [
+        {
+            key: "thinkType",
+            type: "select",
+            label: "Think Action",
+            description: "The type of action to carry out",
+            params: {
+                options: [
+                    {
+                        label: "Think Text (default)",
+                        value: "default",
+                    },
+                    {
+                        label: "Trigger Intent",
+                        value: "intent",
+                    },
+                ],
+            },
+            defaultValue: "default"
+        },
         {
             key: "text",
             type: "cognigyText",
-            label: "Text to think"
+            label: "Text to think",
+            description: "The text to inject back into the Flow",
+            condition: {
+                key: "thinkType",
+                value: "intent",
+                negate: true
+            }
         },
         {
             key: "data",
             type: "json",
             label: "Data to think",
-            defaultValue: "{}"
+            defaultValue: "{}",
+            condition: {
+                key: "thinkType",
+                value: "intent",
+                negate: true
+            }
+        },
+        {
+            key: "intent",
+            type: "cognigyText",
+            label: "Intent to trigger",
+            description: "Cognigy will trigger the intent using the cIntent method",
+            condition: {
+                key: "thinkType",
+                value: "intent"
+            }
+        },
+    ],
+    sections: [
+        {
+            key: "advanced",
+            label: "Advanced",
+            defaultCollapsed: true,
+            fields: [
+                "thinkType",
+                "data"
+            ]
         }
     ],
+    form: [
+        { type: "field", key: "text" },
+        { type: "field", key: "intent" },
+        { type: "section", key: "advanced" },
+    ],
     preview: {
         key: "text",
         type: "text",
     },
-    tags: ["basic", "logic", "recursion"],
+    tags: ["basic", "logic", "recursion", "inject"],
     function: async ({ cognigy, config }) => {
-        const { text, data } = config;
+        const { text, data, intent, thinkType, } = config;
         const { api } = cognigy;
-        if (text || data) {
+        if (thinkType === "intent") {
+            api.think(`cIntent:${intent}`, null);
+        }
+        else if (text || data) {
             api.think(text, data);
         }
     }

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

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.THINK_V2 = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+/**
+ * Node name: 'think'
+ *
+ * Purpose:
+ * Thinks a message into the Flow
+ */
+exports.THINK_V2 = createNodeDescriptor_1.createNodeDescriptor({
+    type: "thinkV2",
+    defaultLabel: "Think",
+    summary: "Restarts Flow execution with a customized message",
+    appearance: {
+        showIcon: false
+    },
+    fields: [
+        {
+            key: "thinkType",
+            type: "select",
+            label: "Think Action",
+            description: "The type of action to carry out",
+            params: {
+                options: [
+                    {
+                        label: "Think Text (default)",
+                        value: "default",
+                    },
+                    {
+                        label: "Trigger Intent",
+                        value: "intent",
+                    },
+                ],
+            },
+            defaultValue: "default"
+        },
+        {
+            key: "text",
+            type: "cognigyText",
+            label: "Text to think",
+            description: "The text to inject back into the Flow",
+            condition: {
+                key: "thinkType",
+                value: "intent",
+                negate: true
+            }
+        },
+        {
+            key: "data",
+            type: "json",
+            label: "Data to think",
+            defaultValue: "{}",
+            condition: {
+                key: "thinkType",
+                value: "intent",
+                negate: true
+            }
+        },
+        {
+            key: "intent",
+            type: "cognigyText",
+            label: "Intent to trigger",
+            description: "Cognigy will trigger the intent using the cIntent method",
+            condition: {
+                key: "thinkType",
+                value: "intent"
+            }
+        },
+    ],
+    sections: [
+        {
+            key: "advanced",
+            label: "Advanced",
+            defaultCollapsed: true,
+            fields: [
+                "thinkType",
+                "data"
+            ]
+        }
+    ],
+    form: [
+        { type: "field", key: "text" },
+        { type: "field", key: "intent" },
+        { type: "section", key: "advanced" },
+    ],
+    preview: {
+        key: "text",
+        type: "text",
+    },
+    tags: ["basic", "logic", "recursion", "inject"],
+    function: async ({ cognigy, config }) => {
+        const { text, data, intent, thinkType, } = config;
+        const { api } = cognigy;
+        if (thinkType === "intent") {
+            api.thinkV2(`cIntent:${intent}`, null);
+        }
+        else if (text || data) {
+            api.thinkV2(text, data);
+        }
+    }
+});
+//# sourceMappingURL=thinkV2.js.map

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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.WAIT = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 exports.WAIT = createNodeDescriptor_1.createNodeDescriptor({
@@ -13,6 +14,7 @@ exports.WAIT = createNodeDescriptor_1.createNodeDescriptor({
         showIcon: false,
         color: "#ec7372",
         textColor: "#ffffff",
+        contrastTextColor: "black",
         variant: "mini"
     },
     constraints: {
@@ -22,15 +24,7 @@ exports.WAIT = createNodeDescriptor_1.createNodeDescriptor({
     tags: ["basic", "logic"],
     function: async ({ cognigy, nodeId }) => {
         const { api } = cognigy;
-        const executionAmount = api.getExecutionAmount(nodeId);
-        const isFirstExecution = executionAmount === 1;
-        if (isFirstExecution) {
-            api.setNextNode(nodeId);
-            api.stopExecution();
-        }
-        else {
-            api.resetExecutionAmount(nodeId);
-        }
+        api.stopExecution();
         return;
     }
 });

package/build/shared/charts/descriptors/message/checkChannelChange/checkChannelChange.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CHECK_CHANNEL_CHANGE = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 /**
@@ -15,6 +16,7 @@ exports.CHECK_CHANNEL_CHANGE = createNodeDescriptor_1.createNodeDescriptor({
     appearance: {
         color: "#90caf9",
         textColor: "white",
+        contrastTextColor: "black",
         variant: "hexagon",
         showIcon: false
     },
@@ -30,7 +32,7 @@ exports.CHECK_CHANNEL_CHANGE = createNodeDescriptor_1.createNodeDescriptor({
             label: "Question"
         },
         {
-            key: "validationmessage",
+            key: "validationMessage",
             type: "cognigyText",
             label: "Validation Message"
         }

package/build/shared/charts/descriptors/message/checkChannelChange/onNo.js

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

package/build/shared/charts/descriptors/message/checkChannelChange/onYes.js

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

package/build/shared/charts/descriptors/message/checkChannelChange/unchanged.js

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

package/build/shared/charts/descriptors/message/datePicker.js

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

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

@@ -1,27 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.UNCHANGED = exports.ON_NO = exports.ON_YES = exports.CHECK_CHANNEL_CHANGE = exports.OPTIONAL_QUESTION = exports.QUESTION = exports.ON_QUESTION = exports.ON_ANSWER = exports.SEND_IMAGE = exports.SEND_TEXT = exports.SAY = exports.DATE_PICKER = void 0;
 var datePicker_1 = require("./datePicker");
-exports.DATE_PICKER = datePicker_1.DATE_PICKER;
+Object.defineProperty(exports, "DATE_PICKER", { enumerable: true, get: function () { return datePicker_1.DATE_PICKER; } });
 var say_1 = require("./say");
-exports.SAY = say_1.SAY;
+Object.defineProperty(exports, "SAY", { enumerable: true, get: function () { return say_1.SAY; } });
 var sendText_1 = require("./sendText");
-exports.SEND_TEXT = sendText_1.SEND_TEXT;
+Object.defineProperty(exports, "SEND_TEXT", { enumerable: true, get: function () { return sendText_1.SEND_TEXT; } });
 var sendImage_1 = require("./sendImage");
-exports.SEND_IMAGE = sendImage_1.SEND_IMAGE;
+Object.defineProperty(exports, "SEND_IMAGE", { enumerable: true, get: function () { return sendImage_1.SEND_IMAGE; } });
 var onAnswer_1 = require("./question/onAnswer");
-exports.ON_ANSWER = onAnswer_1.ON_ANSWER;
+Object.defineProperty(exports, "ON_ANSWER", { enumerable: true, get: function () { return onAnswer_1.ON_ANSWER; } });
 var onQuestion_1 = require("./question/onQuestion");
-exports.ON_QUESTION = onQuestion_1.ON_QUESTION;
+Object.defineProperty(exports, "ON_QUESTION", { enumerable: true, get: function () { return onQuestion_1.ON_QUESTION; } });
 var question_1 = require("./question/question");
-exports.QUESTION = question_1.QUESTION;
+Object.defineProperty(exports, "QUESTION", { enumerable: true, get: function () { return question_1.QUESTION; } });
 var optionalQuestion_1 = require("./question/optionalQuestion");
-exports.OPTIONAL_QUESTION = optionalQuestion_1.OPTIONAL_QUESTION;
+Object.defineProperty(exports, "OPTIONAL_QUESTION", { enumerable: true, get: function () { return optionalQuestion_1.OPTIONAL_QUESTION; } });
 var checkChannelChange_1 = require("./checkChannelChange/checkChannelChange");
-exports.CHECK_CHANNEL_CHANGE = checkChannelChange_1.CHECK_CHANNEL_CHANGE;
+Object.defineProperty(exports, "CHECK_CHANNEL_CHANGE", { enumerable: true, get: function () { return checkChannelChange_1.CHECK_CHANNEL_CHANGE; } });
 var onYes_1 = require("./checkChannelChange/onYes");
-exports.ON_YES = onYes_1.ON_YES;
+Object.defineProperty(exports, "ON_YES", { enumerable: true, get: function () { return onYes_1.ON_YES; } });
 var onNo_1 = require("./checkChannelChange/onNo");
-exports.ON_NO = onNo_1.ON_NO;
+Object.defineProperty(exports, "ON_NO", { enumerable: true, get: function () { return onNo_1.ON_NO; } });
 var unchanged_1 = require("./checkChannelChange/unchanged");
-exports.UNCHANGED = unchanged_1.UNCHANGED;
+Object.defineProperty(exports, "UNCHANGED", { enumerable: true, get: function () { return unchanged_1.UNCHANGED; } });
 //# sourceMappingURL=index.js.map

package/build/shared/charts/descriptors/message/question/onAnswer.js

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

package/build/shared/charts/descriptors/message/question/onQuestion.js

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

package/build/shared/charts/descriptors/message/question/optionalQuestion.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.OPTIONAL_QUESTION = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 const evaluateQuestionAnswer_1 = require("./utils/evaluateQuestionAnswer");
@@ -52,6 +53,10 @@ exports.OPTIONAL_QUESTION = createNodeDescriptor_1.createNodeDescriptor({
                         label: "Age",
                         value: "age",
                     },
+                    {
+                        label: "Url",
+                        value: "url"
+                    },
                     {
                         label: "Duration",
                         value: "duration",
@@ -72,6 +77,10 @@ exports.OPTIONAL_QUESTION = createNodeDescriptor_1.createNodeDescriptor({
                         label: "Regex",
                         value: "regex",
                     },
+                    {
+                        label: "Data",
+                        value: "data",
+                    },
                 ],
             },
             defaultValue: "yesNo",
@@ -146,12 +155,31 @@ exports.OPTIONAL_QUESTION = createNodeDescriptor_1.createNodeDescriptor({
             label: "Stop Flow execution after Answer",
             type: "toggle",
             defaultValue: true
+        },
+        {
+            key: "cognigyScript",
+            type: "select",
+            label: "On which user input should we parse CognigyScript after Answer?",
+            params: {
+                required: true,
+                options: [
+                    {
+                        label: "On the Answer input",
+                        value: "answer"
+                    },
+                    {
+                        label: "On the Question input",
+                        value: "question"
+                    },
+                ]
+            },
+            defaultValue: "answer"
         }
     ],
     sections: [
         {
             key: "context",
-            label: "Authentication",
+            label: "Result Storage",
             defaultCollapsed: true,
             fields: [
                 "storeResultInContext",
@@ -166,7 +194,8 @@ exports.OPTIONAL_QUESTION = createNodeDescriptor_1.createNodeDescriptor({
             fields: [
                 "storeDetailedResults",
                 "executeChildrenOnly",
-                "retentionTime"
+                "retentionTime",
+                "cognigyScript"
             ]
         }
     ],
@@ -180,8 +209,8 @@ exports.OPTIONAL_QUESTION = createNodeDescriptor_1.createNodeDescriptor({
         { type: "section", key: "context" },
     ],
     preview: {
-        key: "say.text.0",
-        type: "text",
+        key: "say",
+        type: "sayNode",
     },
     dependencies: {
         children: ["onAnswer", "onQuestion"],
@@ -192,10 +221,26 @@ exports.OPTIONAL_QUESTION = createNodeDescriptor_1.createNodeDescriptor({
     },
     tags: ["basic", "message", "nlu"],
     function: async ({ cognigy, config, childConfigs, nodeId }) => {
-        const { say, retentionTime = 3, type, regex: regexField, executeChildrenOnly, keyphraseTag, usePositiveOnly, storeResultInContext, contextKey } = config;
+        const { say, retentionTime = 3, type, executeChildrenOnly, cognigyScript, storeResultInContext, contextKey } = config;
+        const { regex: regexField } = config;
+        const { keyphraseTag, usePositiveOnly } = config;
         const { api, input, context } = cognigy;
         const { conditionalEntrypointWasExecuted } = input;
         const onQuestionChild = childConfigs.find(child => child.type === "onQuestion");
+        // remember the current question in systemContext to later fill Input with it
+        let activeQuestion = api.getSystemContext('activeOptionalQuestion');
+        if (!activeQuestion || activeQuestion.nodeId !== nodeId) {
+            activeQuestion = {
+                nodeId,
+                type,
+                lastExecutedAt: input.execution,
+                forgetQuestionThreshold: retentionTime
+            };
+            api.setSystemContext('activeOptionalQuestion', activeQuestion);
+        }
+        else {
+            activeQuestion.lastExecutedAt = input.execution;
+        }
         if (!conditionalEntrypointWasExecuted) {
             let condition;
             switch (type) {
@@ -206,12 +251,16 @@ exports.OPTIONAL_QUESTION = createNodeDescriptor_1.createNodeDescriptor({
                 case "number":
                 case "money":
                 case "percentage":
+                case "url":
                 case "email":
                     condition = `!!input.slots['${type.toUpperCase()}']`;
                     break;
                 case "intent":
                     condition = `!!input.intent`;
                     break;
+                case "data":
+                    condition = `!!input.data`;
+                    break;
                 case "yesNo": {
                     condition = "input.type === 'pAnswer' || input.type === 'nAnswer'";
                     /* Make sure we do not trigger an intent on yes / no answer */
@@ -227,11 +276,15 @@ exports.OPTIONAL_QUESTION = createNodeDescriptor_1.createNodeDescriptor({
                     break;
                 }
             }
-            api.addConditionalEntrypoint({
+            const addConditionalEntrypointParams = {
                 entrypoint: nodeId,
                 retentionTime,
-                condition
-            });
+                condition,
+            };
+            if (cognigyScript === "question") {
+                addConditionalEntrypointParams.cognigyScriptInput = input;
+            }
+            api.addConditionalEntrypoint(addConditionalEntrypointParams);
             say_1.SAY.function({ cognigy, config: { say }, childConfigs: [], nodeId });
             if (onQuestionChild) {
                 api.setNextNode(onQuestionChild.id);
@@ -262,7 +315,11 @@ exports.OPTIONAL_QUESTION = createNodeDescriptor_1.createNodeDescriptor({
         if (executeChildrenOnly) {
             api.setNextNode(null);
         }
+        else {
+            api.resetCognigyScriptInput();
+        }
         api.setNextNode(child.id);
+        api.deleteSystemContext('activeOptionalQuestion');
         api.deleteSystemContext("reconfirmationInProgress");
     }
 });