@cognigy/rest-api-client 0.20.0 → 4.93.0

package/dist/esm/shared/charts/descriptors/liveAgent/assistInfo.js

@@ -0,0 +1,193 @@
+import { __awaiter } from "tslib";
+/* Custom modules */
+import { createNodeDescriptor } from "../../createNodeDescriptor";
+import { buildCognigyWhisperAssistResponse } from "./utils";
+/**
+ * Node name: 'assistInfo'
+ *
+ * Purpose:
+ * Sends an info summary to the live agent
+ */
+export const ASSIST_INFO = createNodeDescriptor({
+    type: "assistInfo",
+    defaultLabel: "Agent Assist Card",
+    summary: "UI__NODE_EDITOR__ASSIST_INFO__SUMMARY",
+    appearance: {
+        showIcon: false,
+    },
+    fields: [
+        {
+            key: "cardType",
+            type: "select",
+            label: "UI__NODE_EDITOR__ASSIST_INFO__CARD_TYPE__LABEL",
+            defaultValue: "basic",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__ASSIST_INFO__CARD_TYPE__BASIC__LABEL",
+                        value: "basic"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__ASSIST_INFO__CARD_TYPE__SUGGESTED__LABEL",
+                        value: "suggested"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__ASSIST_INFO__CARD_TYPE__TABLE__LABEL",
+                        value: "table"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__ASSIST_INFO__CARD_TYPE__CUSTOM__LABEL",
+                        value: "custom"
+                    },
+                ]
+            }
+        },
+        {
+            key: "title",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__ASSIST_INFO__TITLE__LABEL",
+            description: "UI__NODE_EDITOR__ASSIST_INFO__TITLE__DESCRIPTION",
+            defaultValue: "",
+            params: {
+                required: true
+            },
+            condition: {
+                key: "cardType",
+                value: "custom",
+                negate: true
+            },
+        },
+        {
+            key: "subtitle",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__ASSIST_INFO__SUBTITLE__LABEL",
+            description: "UI__NODE_EDITOR__ASSIST_INFO__SUBTITLE__DESCRIPTION",
+            defaultValue: "",
+            params: {
+                required: true
+            },
+            condition: {
+                key: "cardType",
+                value: "custom",
+                negate: true
+            },
+        },
+        {
+            key: "body",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__ASSIST_INFO__BODY__LABEL",
+            description: "UI__NODE_EDITOR__ASSIST_INFO__BODY__DESCRIPTION",
+            defaultValue: "",
+            params: {
+                required: true,
+                multiline: true,
+                rows: 3,
+                maxRows: 5
+            },
+            condition: {
+                key: "cardType",
+                value: "basic"
+            }
+        },
+        {
+            key: "basicImage",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__ASSIST_INFO__IMAGE__LABEL",
+            description: "UI__NODE_EDITOR__ASSIST_INFO__IMAGE__DESCRIPTION",
+            defaultValue: "",
+            condition: {
+                key: "cardType",
+                value: "basic"
+            }
+        },
+        {
+            key: "basicActionTitle",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__ASSIST_INFO__ACTION_TITLE__LABEL",
+            description: "UI__NODE_EDITOR__ASSIST_INFO__ACTION_TITLE__DESCRIPTION",
+            defaultValue: "",
+            condition: {
+                key: "cardType",
+                value: "basic"
+            }
+        },
+        {
+            key: "basicActionUrl",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__ASSIST_INFO__ACTION_URL__LABEL",
+            description: "UI__NODE_EDITOR__ASSIST_INFO__ACTION_URL__DESCRIPTION",
+            defaultValue: "",
+            condition: {
+                key: "cardType",
+                value: "basic"
+            }
+        },
+        {
+            key: "body",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__ASSIST_INFO__BODY__SUGGESTED__LABEL",
+            description: "UI__NODE_EDITOR__ASSIST_INFO__BODY__SUGGESTED__DESCRIPTION",
+            defaultValue: "",
+            params: {
+                required: true,
+                multiline: true,
+                rows: 3,
+                maxRows: 5
+            },
+            condition: {
+                key: "cardType",
+                value: "suggested"
+            }
+        },
+        {
+            key: "suggestedActionTitles",
+            type: "cognigyTextArray",
+            label: "UI__NODE_EDITOR__ASSIST_INFO__SUGGESTED_ACTION_TITLES__LABEL",
+            description: "UI__NODE_EDITOR__ASSIST_INFO__SUGGESTED_ACTION_TITLES__DESCRIPTION",
+            condition: {
+                key: "cardType",
+                value: "suggested"
+            }
+        },
+        {
+            key: "tableFacts",
+            type: "keyValuePairs",
+            label: "UI__NODE_EDITOR__ASSIST_INFO__TABLE_FACTS__LABEL",
+            description: "UI__NODE_EDITOR__ASSIST_INFO__TABLE_FACTS__DESCRIPTION",
+            defaultValue: "{}",
+            params: {
+                required: true
+            },
+            condition: {
+                key: "cardType",
+                value: "table"
+            }
+        },
+        {
+            key: "customJson",
+            type: "json",
+            label: "UI__NODE_EDITOR__ASSIST_INFO__CUSTOM_JSON__LABEL",
+            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: ({ cognigy, config }) => __awaiter(void 0, void 0, void 0, function* () {
+        const { api } = cognigy;
+        const dataResponse = buildCognigyWhisperAssistResponse(config);
+        api.say("", dataResponse);
+    }),
+});
+//# sourceMappingURL=assistInfo.js.map

package/dist/esm/shared/charts/descriptors/liveAgent/index.js

@@ -0,0 +1,2 @@
+export { ASSIST_INFO } from "./assistInfo";
+//# sourceMappingURL=index.js.map

package/dist/esm/shared/charts/descriptors/liveAgent/utils/buildCognigyWhisperAssistResponse.js

@@ -0,0 +1,131 @@
+export 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
+            }
+        }
+    };
+};
+//# sourceMappingURL=buildCognigyWhisperAssistResponse.js.map

package/dist/esm/shared/charts/descriptors/liveAgent/utils/index.js

@@ -0,0 +1,2 @@
+export { buildCognigyWhisperAssistResponse } from "./buildCognigyWhisperAssistResponse";
+//# sourceMappingURL=index.js.map

package/dist/esm/shared/charts/descriptors/logic/disableSlotFillers.js

@@ -0,0 +1,50 @@
+import { __awaiter } from "tslib";
+/* Custom modules */
+import { createNodeDescriptor } from "../../createNodeDescriptor";
+/**
+ * Node name: 'disableSlotFillers'
+ *
+ * Purpose:
+ * Disables slot fillers
+ */
+export const DISABLE_SLOT_FILLERS = createNodeDescriptor({
+    type: "disableSlotFillers",
+    defaultLabel: "Disable Slot Fillers",
+    summary: "UI__NODE_EDITOR__DISABLE_SLOT_FILLERS__SUMMARY",
+    appearance: {
+        showIcon: false
+    },
+    fields: [
+        {
+            key: "slotFillersToDisable",
+            type: "slotFillerArray",
+            label: "UI__NODE_EDITOR__DISABLE_SLOT_FILLERS__SLOT_FILLERS_TO_DISABLE__LABEL",
+            description: "UI__NODE_EDITOR__DISABLE_SLOT_FILLERS__SLOT_FILLERS_TO_DISABLE__DESCRIPTION"
+        },
+        {
+            key: "reset",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__DISABLE_SLOT_FILLERS__RESET__LABEL",
+        }
+    ],
+    tags: ["ai", "nlu"],
+    function: ({ cognigy, config }) => __awaiter(void 0, void 0, void 0, function* () {
+        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/dist/esm/shared/charts/descriptors/logic/enableSlotFillers.js

@@ -0,0 +1,44 @@
+import { __awaiter } from "tslib";
+/* Custom modules */
+import { createNodeDescriptor } from "../../createNodeDescriptor";
+/**
+ * Node name: 'enableSlotFillers'
+ *
+ * Purpose:
+ * Enables slot fillers
+ */
+export const ENABLE_SLOT_FILLERS = createNodeDescriptor({
+    type: "enableSlotFillers",
+    defaultLabel: "Enable Slot Fillers",
+    summary: "UI__NODE_EDITOR__ENABLE_SLOT_FILLERS__SUMMARY",
+    appearance: {
+        showIcon: false
+    },
+    fields: [
+        {
+            key: "slotFillersToEnable",
+            type: "slotFillerArray",
+            label: "UI__NODE_EDITOR__ENABLE_SLOT_FILLERS__SLOT_FILLERS_TO_ENABLE__LABEL",
+            description: "UI__NODE_EDITOR__ENABLE_SLOT_FILLERS__SLOT_FILLERS_TO_ENABLE__DESCRIPTION"
+        }
+    ],
+    tags: ["ai", "nlu"],
+    function: ({ cognigy, config }) => __awaiter(void 0, void 0, void 0, function* () {
+        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/dist/esm/shared/charts/descriptors/logic/executeFlow.js

@@ -0,0 +1,87 @@
+import { __awaiter } from "tslib";
+/* Custom modules */
+import { createNodeDescriptor } from "../../createNodeDescriptor";
+/**
+ * Node name: 'executeFlow'
+ *
+ * Purpose:
+ * Executes a given node in a given Flow
+ */
+export const EXECUTE_FLOW = createNodeDescriptor({
+    type: "executeFlow",
+    defaultLabel: "Execute Flow",
+    summary: "UI__NODE_EDITOR__EXECUTE_FLOW__SUMMARY",
+    appearance: {
+        showIcon: false
+    },
+    fields: [
+        {
+            key: "flowNode",
+            type: "flowNode",
+            label: "UI__NODE_EDITOR__EXECUTE_FLOW__FLOW_NODE__LABEL",
+        },
+        {
+            key: "parseIntents",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__EXECUTE_FLOW__PARSE_INTENTS__LABEL",
+            description: "UI__NODE_EDITOR__EXECUTE_FLOW__PARSE_INTENTS__DESCRIPTION",
+            defaultValue: true
+        },
+        {
+            key: "parseKeyphrases",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__EXECUTE_FLOW__PARSE_KEYPHRASES__LABEL",
+            description: "UI__NODE_EDITOR__EXECUTE_FLOW__PARSE_KEYPHRASES__DESCRIPTION",
+            defaultValue: true
+        },
+        {
+            key: "absorbContext",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__EXECUTE_FLOW__ABSORB_CONTEXT__LABEL",
+            description: "UI__NODE_EDITOR__EXECUTE_FLOW__ABSORB_CONTEXT__DESCRIPTION",
+        }
+    ],
+    sections: [
+        {
+            key: "advanced",
+            label: "UI__NODE_EDITOR__EXECUTE_FLOW__ADVANCED__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "parseIntents",
+                "parseKeyphrases",
+                "absorbContext"
+            ]
+        }
+    ],
+    form: [
+        { type: "field", key: "flowNode" },
+        { type: "section", key: "advanced" },
+    ],
+    preview: {
+        key: "flowNode",
+        type: "resource",
+    },
+    tags: ["logic"],
+    function: ({ cognigy, config, nodeId: thisNodeId }) => __awaiter(void 0, void 0, void 0, function* () {
+        const { flowNode: { flow: flowId, node: nodeId }, parseIntents, parseKeyphrases, absorbContext } = config;
+        const { api } = cognigy;
+        if (!flowId) {
+            throw new Error("flowId is required");
+        }
+        if (!api.checkThink(thisNodeId)) {
+            yield api.executeFlow({
+                flowNode: {
+                    flow: flowId,
+                    node: nodeId || null
+                },
+                absorbContext,
+                parseIntents,
+                parseKeyphrases
+            });
+        }
+        else {
+            throw new Error("Infinite Loop Detected");
+        }
+    })
+});
+//# sourceMappingURL=executeFlow.js.map

package/dist/esm/shared/charts/descriptors/logic/goTo.js

@@ -0,0 +1,168 @@
+import { __awaiter } from "tslib";
+/* Custom modules */
+import { createNodeDescriptor } from "../../createNodeDescriptor";
+/**
+ * Node name: 'goTo'
+ *
+ * Purpose:
+ * Jumps to a given node in a given Flow
+ */
+export const GO_TO = createNodeDescriptor({
+    type: "goTo",
+    defaultLabel: "Go To",
+    summary: "UI__NODE_EDITOR__GO_TO__SUMMARY",
+    appearance: {
+        showIcon: false,
+    },
+    behavior: {
+        stopping: true
+    },
+    fields: [
+        {
+            key: "flowNode",
+            type: "flowNode",
+            label: "UI__NODE_EDITOR__GO_TO__FLOW_NODE__LABEL",
+            params: {
+                required: true
+            }
+        },
+        {
+            key: "absorbContext",
+            type: "toggle",
+            description: "UI__NODE_EDITOR__GO_TO__ABSORB_CONTEXT__DESCRIPTION",
+            label: "UI__NODE_EDITOR__GO_TO__ABSORB_CONTEXT__LABEL",
+            defaultValue: false
+        },
+        {
+            key: "executionMode",
+            type: "select",
+            description: "UI__NODE_EDITOR__GO_TO__EXECUTION_MODE__DESCRIPTION",
+            label: "UI__NODE_EDITOR__GO_TO__EXECUTION_MODE__LABEL",
+            defaultValue: "continue",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__GO_TO__EXECUTION_MODE__CONTINUE__LABEL",
+                        value: "continue"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__GO_TO__EXECUTION_MODE__WAIT__LABEL",
+                        value: "wait"
+                    },
+                ]
+            }
+        },
+        {
+            key: "injectedText",
+            label: "UI__NODE_EDITOR__GO_TO__INJECTED_TEXT__LABEL",
+            type: "cognigyText",
+            description: "UI__NODE_EDITOR__GO_TO__INJECTED_TEXT__DESCRIPTION",
+            defaultValue: "",
+            condition: {
+                key: "executionMode",
+                value: "continue"
+            }
+        },
+        {
+            key: "injectedData",
+            label: "UI__NODE_EDITOR__GO_TO__INJECTED_DATA__LABEL",
+            type: "json",
+            description: "UI__NODE_EDITOR__GO_TO__INJECTED_DATA__DESCRIPTION",
+            defaultValue: "{}",
+            condition: {
+                key: "executionMode",
+                value: "continue"
+            }
+        },
+        {
+            key: "parseIntents",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__GO_TO__PARSE_INTENTS__LABEL",
+            description: "UI__NODE_EDITOR__GO_TO__PARSE_INTENTS__DESCRIPTION",
+            defaultValue: false,
+            condition: {
+                key: "executionMode",
+                value: "continue"
+            }
+        },
+        {
+            key: "parseKeyphrases",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__GO_TO__PARSE_KEYPHRASES__LABEL",
+            description: "UI__NODE_EDITOR__GO_TO__PARSE_KEYPHRASES__DESCRIPTION",
+            defaultValue: false,
+            condition: {
+                key: "executionMode",
+                value: "continue"
+            }
+        },
+    ],
+    sections: [
+        {
+            key: "advanced",
+            label: "UI__NODE_EDITOR__GO_TO__ADVANCED__LABEL",
+            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: ({ cognigy, config, nodeId: thisNodeId }) => __awaiter(void 0, void 0, void 0, function* () {
+        const { flowNode: { flow: flowId, node: nodeId }, absorbContext, executionMode, injectedText, injectedData, parseIntents, parseKeyphrases } = config;
+        const { api } = cognigy;
+        if (!flowId) {
+            throw new Error("flowId is required");
+        }
+        if (!nodeId) {
+            throw new Error("nodeId is required");
+        }
+        if (!api.checkThink(thisNodeId)) {
+            api.resetNextNodes();
+            api.setThinkMarker(config.flowNode.flow);
+            // Check if execution is to wait at Node for Input
+            if (executionMode === "wait") {
+                // only set the next node if the execution mode is "wait",
+                // otherwise input after the goto node would again go to this node, and not to the start node
+                yield 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
+            yield api.executeFlow({
+                flowNode: {
+                    flow: flowId,
+                    node: nodeId,
+                    isGoto: true,
+                },
+                absorbContext,
+                parseIntents,
+                parseKeyphrases
+            });
+        }
+        else {
+            throw new Error("Infinite Loop Detected");
+        }
+    }),
+});
+//# sourceMappingURL=goTo.js.map