@cognigy/rest-api-client 0.9.1 → 0.12.0

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

@@ -1,45 +1,54 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SET_TRANSLATION = exports.SWITCH_LOCALE = exports.GO_TO = exports.EXECUTE_FLOW = exports.DISABLE_SLOT_FILLERS = exports.ENABLE_SLOT_FILLERS = exports.THINK_V2 = exports.THINK = exports.SET_STATE = exports.RESET_STATE = exports.WAIT = exports.SLEEP = exports.AFTERWARDS = exports.ON_FIRST_EXECUTION = exports.ONCE = exports.ON_INTERVAL = exports.ELSE_INTERVAL = exports.INTERVAL = exports.STOP = exports.DEFAULT = exports.CASE = exports.SWITCH = exports.ELSE = exports.THEN = exports.IF = void 0;
 var if_1 = require("./if/if");
-exports.IF = if_1.IF;
+Object.defineProperty(exports, "IF", { enumerable: true, get: function () { return if_1.IF; } });
 var then_1 = require("./if/then");
-exports.THEN = then_1.THEN;
+Object.defineProperty(exports, "THEN", { enumerable: true, get: function () { return then_1.THEN; } });
 var else_1 = require("./if/else");
-exports.ELSE = else_1.ELSE;
+Object.defineProperty(exports, "ELSE", { enumerable: true, get: function () { return else_1.ELSE; } });
 var switch_1 = require("./switch/switch");
-exports.SWITCH = switch_1.SWITCH;
+Object.defineProperty(exports, "SWITCH", { enumerable: true, get: function () { return switch_1.SWITCH; } });
 var case_1 = require("./switch/case");
-exports.CASE = case_1.CASE;
+Object.defineProperty(exports, "CASE", { enumerable: true, get: function () { return case_1.CASE; } });
 var default_1 = require("./switch/default");
-exports.DEFAULT = default_1.DEFAULT;
+Object.defineProperty(exports, "DEFAULT", { enumerable: true, get: function () { return default_1.DEFAULT; } });
 var stop_1 = require("./stop");
-exports.STOP = stop_1.STOP;
-var checkFrustration_1 = require("./checkFrustration");
-exports.CHECK_FRUSTRATION = checkFrustration_1.CHECK_FRUSTRATION;
+Object.defineProperty(exports, "STOP", { enumerable: true, get: function () { return stop_1.STOP; } });
 var interval_1 = require("./interval/interval");
-exports.INTERVAL = interval_1.INTERVAL;
+Object.defineProperty(exports, "INTERVAL", { enumerable: true, get: function () { return interval_1.INTERVAL; } });
 var elseInterval_1 = require("./interval/elseInterval");
-exports.ELSE_INTERVAL = elseInterval_1.ELSE_INTERVAL;
+Object.defineProperty(exports, "ELSE_INTERVAL", { enumerable: true, get: function () { return elseInterval_1.ELSE_INTERVAL; } });
 var onInterval_1 = require("./interval/onInterval");
-exports.ON_INTERVAL = onInterval_1.ON_INTERVAL;
+Object.defineProperty(exports, "ON_INTERVAL", { enumerable: true, get: function () { return onInterval_1.ON_INTERVAL; } });
 var once_1 = require("./once/once");
-exports.ONCE = once_1.ONCE;
+Object.defineProperty(exports, "ONCE", { enumerable: true, get: function () { return once_1.ONCE; } });
 var onFirstExecution_1 = require("./once/onFirstExecution");
-exports.ON_FIRST_EXECUTION = onFirstExecution_1.ON_FIRST_EXECUTION;
+Object.defineProperty(exports, "ON_FIRST_EXECUTION", { enumerable: true, get: function () { return onFirstExecution_1.ON_FIRST_EXECUTION; } });
 var afterwards_1 = require("./once/afterwards");
-exports.AFTERWARDS = afterwards_1.AFTERWARDS;
+Object.defineProperty(exports, "AFTERWARDS", { enumerable: true, get: function () { return afterwards_1.AFTERWARDS; } });
 var sleep_1 = require("./sleep");
-exports.SLEEP = sleep_1.SLEEP;
+Object.defineProperty(exports, "SLEEP", { enumerable: true, get: function () { return sleep_1.SLEEP; } });
 var wait_1 = require("./wait");
-exports.WAIT = wait_1.WAIT;
+Object.defineProperty(exports, "WAIT", { enumerable: true, get: function () { return wait_1.WAIT; } });
 var resetState_1 = require("./resetState");
-exports.RESET_STATE = resetState_1.RESET_STATE;
+Object.defineProperty(exports, "RESET_STATE", { enumerable: true, get: function () { return resetState_1.RESET_STATE; } });
 var setState_1 = require("./setState");
-exports.SET_STATE = setState_1.SET_STATE;
+Object.defineProperty(exports, "SET_STATE", { enumerable: true, get: function () { return setState_1.SET_STATE; } });
 var think_1 = require("./think");
-exports.THINK = think_1.THINK;
+Object.defineProperty(exports, "THINK", { enumerable: true, get: function () { return think_1.THINK; } });
+var thinkV2_1 = require("./thinkV2");
+Object.defineProperty(exports, "THINK_V2", { enumerable: true, get: function () { return thinkV2_1.THINK_V2; } });
+var enableSlotFillers_1 = require("./enableSlotFillers");
+Object.defineProperty(exports, "ENABLE_SLOT_FILLERS", { enumerable: true, get: function () { return enableSlotFillers_1.ENABLE_SLOT_FILLERS; } });
+var disableSlotFillers_1 = require("./disableSlotFillers");
+Object.defineProperty(exports, "DISABLE_SLOT_FILLERS", { enumerable: true, get: function () { return disableSlotFillers_1.DISABLE_SLOT_FILLERS; } });
 var executeFlow_1 = require("./executeFlow");
-exports.EXECUTE_FLOW = executeFlow_1.EXECUTE_FLOW;
+Object.defineProperty(exports, "EXECUTE_FLOW", { enumerable: true, get: function () { return executeFlow_1.EXECUTE_FLOW; } });
 var goTo_1 = require("./goTo");
-exports.GO_TO = goTo_1.GO_TO;
+Object.defineProperty(exports, "GO_TO", { enumerable: true, get: function () { return goTo_1.GO_TO; } });
+var switchLocale_1 = require("./switchLocale");
+Object.defineProperty(exports, "SWITCH_LOCALE", { enumerable: true, get: function () { return switchLocale_1.SWITCH_LOCALE; } });
+var setTranslation_1 = require("./setTranslation");
+Object.defineProperty(exports, "SET_TRANSLATION", { enumerable: true, get: function () { return setTranslation_1.SET_TRANSLATION; } });
 //# sourceMappingURL=index.js.map

package/build/shared/charts/descriptors/logic/interval/elseInterval.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ELSE_INTERVAL = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 exports.ELSE_INTERVAL = createNodeDescriptor_1.createNodeDescriptor({
@@ -15,6 +16,7 @@ exports.ELSE_INTERVAL = createNodeDescriptor_1.createNodeDescriptor({
         editable: false,
         deletable: false,
         collapsable: true,
+        childFlowCreatable: true,
         creatable: false,
         placement: {},
     },

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

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

package/build/shared/charts/descriptors/logic/interval/onInterval.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ON_INTERVAL = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 exports.ON_INTERVAL = createNodeDescriptor_1.createNodeDescriptor({
@@ -15,6 +16,7 @@ exports.ON_INTERVAL = createNodeDescriptor_1.createNodeDescriptor({
         editable: false,
         deletable: false,
         collapsable: true,
+        childFlowCreatable: true,
         creatable: false,
         placement: {},
     },

package/build/shared/charts/descriptors/logic/once/afterwards.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AFTERWARDS = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 exports.AFTERWARDS = createNodeDescriptor_1.createNodeDescriptor({
@@ -15,6 +16,7 @@ exports.AFTERWARDS = createNodeDescriptor_1.createNodeDescriptor({
         editable: false,
         deletable: false,
         collapsable: true,
+        childFlowCreatable: true,
         creatable: false,
         placement: {},
     },

package/build/shared/charts/descriptors/logic/once/onFirstExecution.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ON_FIRST_EXECUTION = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 exports.ON_FIRST_EXECUTION = createNodeDescriptor_1.createNodeDescriptor({
@@ -15,6 +16,7 @@ exports.ON_FIRST_EXECUTION = createNodeDescriptor_1.createNodeDescriptor({
         editable: false,
         deletable: false,
         collapsable: true,
+        childFlowCreatable: true,
         creatable: false,
         placement: {},
     },

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

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

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

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

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

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

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

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SET_TRANSLATION = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+exports.SET_TRANSLATION = createNodeDescriptor_1.createNodeDescriptor({
+    type: "setTranslation",
+    defaultLabel: "Set Translation",
+    summary: "Dynamically sets Endpoint Translation settings",
+    fields: [
+        {
+            key: "translationEnabled",
+            label: "Translation Enabled",
+            description: "Whether translation is activated in the Endpoint or not",
+            type: "toggle",
+            defaultValue: false
+        },
+        {
+            key: "inputLanguage",
+            label: "User Input Language",
+            description: "The language of the user input",
+            type: "cognigyText"
+        },
+        {
+            key: "flowLanguage",
+            label: "Flow Language",
+            description: "The language to translate to",
+            type: "cognigyText"
+        },
+        {
+            key: "padPayloads",
+            label: "Don't translate Payloads",
+            description: "Whether to preserve payloads by so they aren't translated when they are returned",
+            type: "toggle",
+            defaultValue: true
+        },
+        {
+            key: "noTranslateMarker",
+            label: "No-Translation Marker",
+            description: "Do not translate texts encapsulated in this marker (e.g. 'I love the ** Cognigy.AI ** platform' will not translate 'Cognigy.AI')",
+            type: "cognigyText",
+            defaultValue: "**"
+        },
+        {
+            key: "setInputLanguageOnExecutionCount",
+            label: "Set user input language on execution count",
+            description: "If the input language is set to 'Auto-Detect', it will be fixed to its current value on this execution count",
+            type: "slider",
+            params: {
+                min: 0,
+                max: 10,
+                step: 1
+            },
+            defaultValue: 0
+        },
+        {
+            key: "alwaysRemoveNoTranslateMarker",
+            label: "Always remove No-Translation Markers",
+            description: "Wether we remove No-Translation Markers, even if translation is not enabled",
+            type: "toggle",
+            defaultValue: true
+        },
+    ],
+    sections: [],
+    form: [
+        { type: "field", key: "translationEnabled" },
+        { type: "field", key: "inputLanguage" },
+        { type: "field", key: "flowLanguage" },
+        { type: "field", key: "padPayloads" },
+        { type: "field", key: "noTranslateMarker" },
+        { type: "field", key: "setInputLanguageOnExecutionCount" },
+        { type: "field", key: "alwaysRemoveNoTranslateMarker" },
+    ],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { translationEnabled, flowLanguage, inputLanguage, padPayloads, alwaysRemoveNoTranslateMarker, noTranslateMarker, setInputLanguageOnExecutionCount } = config;
+        api.setTranslationSettings({
+            translationEnabled,
+            flowLanguage,
+            inputLanguage,
+            padPayloads,
+            alwaysRemoveNoTranslateMarker,
+            noTranslateMarker,
+            setInputLanguageOnExecutionCount
+        });
+    }
+});
+//# sourceMappingURL=setTranslation.js.map

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

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

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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.STOP = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 exports.STOP = createNodeDescriptor_1.createNodeDescriptor({
@@ -17,11 +18,7 @@ exports.STOP = createNodeDescriptor_1.createNodeDescriptor({
     },
     constraints: {
         editable: false,
-        placement: {
-            successor: {
-                whitelist: [],
-            },
-        },
+        placement: {}
     },
     tags: ["basic", "logic"],
     function: async ({ cognigy }) => {

package/build/shared/charts/descriptors/logic/switch/case.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CASE = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 exports.CASE = createNodeDescriptor_1.createNodeDescriptor({
@@ -9,10 +10,12 @@ exports.CASE = createNodeDescriptor_1.createNodeDescriptor({
     appearance: {
         color: "#FFC237",
         textColor: "white",
+        contrastTextColor: "black",
         variant: "mini",
     },
     constraints: {
         collapsable: true,
+        childFlowCreatable: true,
         placement: {},
     },
     fields: [

package/build/shared/charts/descriptors/logic/switch/default.js

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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SWITCH = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 exports.SWITCH = createNodeDescriptor_1.createNodeDescriptor({
@@ -9,6 +10,7 @@ exports.SWITCH = createNodeDescriptor_1.createNodeDescriptor({
     appearance: {
         color: "#FFC237",
         textColor: "white",
+        contrastTextColor: "black",
         variant: "hexagon",
         showIcon: false,
     },
@@ -25,9 +27,9 @@ exports.SWITCH = createNodeDescriptor_1.createNodeDescriptor({
     },
     fields: [
         {
-            label: "_unused_",
-            type: "switchNode",
             key: "switch",
+            type: "switchNode",
+            label: "Type",
             params: {
                 required: true,
                 options: [
@@ -35,6 +37,10 @@ exports.SWITCH = createNodeDescriptor_1.createNodeDescriptor({
                         label: "Intent",
                         value: "intent",
                     },
+                    {
+                        label: "Text",
+                        value: "text",
+                    },
                     {
                         label: "State",
                         value: "state",
@@ -47,6 +53,10 @@ exports.SWITCH = createNodeDescriptor_1.createNodeDescriptor({
                         label: "Mode",
                         value: "mode",
                     },
+                    {
+                        label: "Handover Status",
+                        value: "handoverStatus",
+                    },
                     {
                         label: "CognigyScript",
                         value: "cognigyScript",
@@ -58,6 +68,66 @@ exports.SWITCH = createNodeDescriptor_1.createNodeDescriptor({
                 operator: "ci.intent"
             },
         },
+        {
+            key: "intentLevel",
+            type: "select",
+            label: "Intent Level",
+            description: "The Intent hierarchy level on which Intents are found. By default, the Intent on the most detailed level is matched.",
+            condition: {
+                /** The key of the Field whose value should be matched */
+                key: "switch.type",
+                /** The expected value(s) that make this condition match */
+                value: "intent",
+            },
+            params: {
+                required: false,
+                options: [
+                    {
+                        label: "Default",
+                        value: "input.intent",
+                    },
+                    {
+                        label: "Level 1",
+                        value: "input.intentLevel.level1",
+                        groupName: "intentLevel"
+                    },
+                    {
+                        label: "Level 2",
+                        value: "input.intentLevel.level2",
+                        indentation: 1,
+                        groupName: "intentLevel"
+                    },
+                    {
+                        label: "Level 3",
+                        value: "input.intentLevel.level3",
+                        indentation: 2,
+                        groupName: "intentLevel"
+                    },
+                ],
+            },
+            defaultValue: "input.intent",
+        },
+        {
+            key: "useStrict",
+            label: "Use Strict Mode",
+            type: "toggle",
+            description: "Whether to evaluate the Switch Node in Strict Mode"
+        }
+    ],
+    sections: [
+        {
+            key: "advanced",
+            label: "Advanced",
+            defaultCollapsed: true,
+            fields: [
+                "useStrict"
+            ]
+        },
+    ],
+    form: [
+        { type: "field", key: "switch" },
+        { type: "field", key: "intentLevel" },
+        { type: "section", key: "advanced" }
     ],
     preview: {
         key: "switch.operator",
@@ -65,22 +135,28 @@ exports.SWITCH = createNodeDescriptor_1.createNodeDescriptor({
     },
     tags: ["basic", "logic", "switch", "branch"],
     function: async ({ cognigy, config, childConfigs: children }) => {
-        var _a, _b;
+        var _a;
         const { api } = cognigy;
-        const { switch: { type }, } = config;
+        const { switch: { type }, useStrict, intentLevel, } = config;
         let { switch: { operator }, } = config;
         switch (type) {
             case "intent":
-                operator = "ci.intent";
+                operator = intentLevel || "input.intent";
                 break;
             case "state":
-                operator = "ci.state";
+                operator = "input.state";
                 break;
             case "type":
-                operator = "ci.type";
+                operator = "input.type";
                 break;
             case "mode":
-                operator = "ci.mode";
+                operator = "input.mode";
+                break;
+            case "text":
+                operator = "input.text";
+                break;
+            case "handoverStatus":
+                operator = "input.handover.status";
                 break;
             case "cognigyScript":
             default:
@@ -92,16 +168,35 @@ exports.SWITCH = createNodeDescriptor_1.createNodeDescriptor({
          * in the operator field. In case the user
          * has used {{}} markers in the operator field
          * by mistake, then CS has already been parsed,
-         * causing the parser return undefined.
+         * causing the parser return empty string.
          */
-        operator = api.parseCognigyScriptText(`{{${operator}}}`) || operator;
-        const matchedCase = (_a = children) === null || _a === void 0 ? void 0 : _a.find((child) => child.type === "case" &&
-            api.parseCognigyScriptText(`${child.config.case.value}`) === operator);
+        let parsedOperator = (_a = api.parseCognigyScriptText(`{{${operator}}}`)) !== null && _a !== void 0 ? _a : operator;
+        if (parsedOperator === "") {
+            parsedOperator = operator;
+        }
+        const matchedCase = children === null || children === void 0 ? void 0 : children.find((child) => {
+            if (child.type !== "case") {
+                return;
+            }
+            if (useStrict) {
+                return api.parseCognigyScriptText(`${child.config.case.value}`) === parsedOperator;
+            }
+            else {
+                /**
+                 * We cast the case
+                 * and the operator to strings to avoid issues
+                 * where e.g. the case contains a string but the
+                 * operator is a number. We do not support switching on
+                 * objects
+                 */
+                return `${api.parseCognigyScriptText(`${child.config.case.value}`)}` === `${parsedOperator}`;
+            }
+        });
         if (matchedCase) {
             api.setNextNode(matchedCase.id);
             return;
         }
-        const defaultCase = (_b = children) === null || _b === void 0 ? void 0 : _b.find((child) => child.type === "default");
+        const defaultCase = children === null || children === void 0 ? void 0 : children.find((child) => child.type === "default");
         if (defaultCase) {
             api.setNextNode(defaultCase.id);
             return;

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

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SWITCH_LOCALE = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+/**
+ * Node name: 'switchLocale'
+ *
+ * Purpose:
+ * Switches the session into another Locale
+ */
+exports.SWITCH_LOCALE = createNodeDescriptor_1.createNodeDescriptor({
+    type: "switchLocale",
+    defaultLabel: "Switch Locale",
+    summary: "Switches the session to another Locale",
+    appearance: {
+        showIcon: false
+    },
+    fields: [
+        {
+            key: "getLocaleFromScript",
+            type: "toggle",
+            label: "Use Cognigy Script",
+            defaultValue: false
+        },
+        {
+            key: "localeReferenceId",
+            type: "localeField",
+            label: "Locale",
+            condition: {
+                key: "getLocaleFromScript",
+                value: false
+            },
+            params: {
+                required: true
+            }
+        },
+        {
+            key: "localeScript",
+            type: "cognigyText",
+            label: "Locale",
+            description: "Use Cognigy Script to select the Locale Reference ID",
+            condition: {
+                key: "getLocaleFromScript",
+                value: true
+            },
+            params: {
+                required: true
+            }
+        }
+    ],
+    tags: ["logic", "locale", "language"],
+    function: async ({ cognigy, config }) => {
+        const { localeReferenceId, localeScript, getLocaleFromScript } = config;
+        const { api } = cognigy;
+        if (getLocaleFromScript) {
+            await api.setLocaleReferenceId(localeScript);
+        }
+        else {
+            await api.setLocaleReferenceId(localeReferenceId);
+        }
+    }
+});
+//# sourceMappingURL=switchLocale.js.map