@cognigy/rest-api-client 0.14.0 → 0.16.0

package/build/shared/charts/descriptors/agentAssist/nextActionAssist.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NEXT_ACTION_ASSIST = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+const nextActionWidgetTemplate_1 = require("./htmlTemplates/nextActionWidgetTemplate");
+/**
+ * Node name: "nextActionAssist"
+ *
+ * Purpose:
+ * The Next Action Assist widget will suggest agent responses and provide more information to draft messages.
+ */
+exports.NEXT_ACTION_ASSIST = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "nextActionAssist",
+    defaultLabel: "Copilot: Next Action Tile",
+    summary: "UI__NODE_EDITOR__NEXT_ACTION_ASSIST__SUMMARY",
+    appearance: {
+        showIcon: false,
+    },
+    tags: ["agentAssist"],
+    fields: [
+        {
+            key: "tileId",
+            label: "UI__NODE_EDITOR__NEXT_ACTION_ASSIST__ID__LABEL",
+            type: "cognigyText",
+            description: "UI__NODE_EDITOR__NEXT_ACTION_ASSIST_TILE_ID__DESCRIPTION",
+            defaultValue: "next-action",
+            params: {
+                required: true,
+            },
+        },
+        {
+            key: "text",
+            label: "UI__NODE_EDITOR__NEXT_ACTION_ASSIST__TEXT__LABEL",
+            type: "cognigyText",
+            description: "UI__NODE_EDITOR__NEXT_ACTION_ASSIST__TEXT__DESCRIPTION",
+            defaultValue: "",
+            params: {
+                required: true,
+            },
+        },
+    ],
+    sections: [],
+    form: [
+        { type: "field", key: "tileId" },
+        { type: "field", key: "text" },
+    ].filter((element) => !!element),
+    function: async (params) => {
+        const { cognigy, config } = params;
+        const { api } = cognigy;
+        const text = config["text"];
+        if (!config.text) {
+            api.log("error", "Please provide a text in the text field");
+            return;
+        }
+        try {
+            const data = {
+                html: (0, nextActionWidgetTemplate_1.default)(text),
+            };
+            cognigy.api.sendTileUpdateToAgentAssistWorkspace(Object.assign(Object.assign({}, params), { tile: {
+                    id: config.tileId,
+                    type: "html",
+                    data, // the generated HTML
+                } }));
+        }
+        catch (error) {
+            if (error instanceof SyntaxError) {
+                api.log("error", "Please provide a valid JSON in the JSON Data field");
+            }
+            else {
+                api.log("error", error);
+            }
+        }
+        return;
+    },
+});
+//# sourceMappingURL=nextActionAssist.js.map

package/build/shared/charts/descriptors/agentAssist/sentimentAssist.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SENTIMENT_ASSIST = void 0;
+/* Custom Modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+/* Templates */
+const sentimentAnalysisTemplate_1 = require("./htmlTemplates/sentimentAnalysisTemplate");
+const prompt_1 = require("../nlu/generativeSlotFiller/prompt");
+const constants_1 = require("./constants/constants");
+const sentiment_helper_1 = require("./helpers/sentiment.helper");
+/**
+ * Node name: "sentimentAssist"
+ *
+ * Purpose:
+ * Set a Sentiment Assist Tile for the Agent Assist Workspace
+ */
+exports.SENTIMENT_ASSIST = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "sentimentAssist",
+    defaultLabel: "Copilot: Sentiment Tile",
+    summary: "UI__NODE_EDITOR__SENTIMENT_ASSIST__SUMMARY",
+    appearance: {
+        showIcon: false,
+    },
+    tags: ["agentAssist"],
+    fields: [
+        {
+            key: "tileId",
+            label: "UI__NODE_EDITOR__SENTIMENT_ASSIST__FIELDS__TILE_ID__LABEL",
+            description: "UI__NODE_EDITOR__SENTIMENT_ASSIST__FIELDS__TILE_ID__DESCRIPTION",
+            type: "cognigyText",
+            defaultValue: "sentiment",
+        },
+        {
+            key: "sentimentAnalysisInput",
+            label: "UI__NODE_EDITOR__SENTIMENT_ASSIST__FIELDS__SENTIMENT_ANALYSIS_INPUT__LABEL",
+            type: "select",
+            defaultValue: "lastInput",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__SENTIMENT_ASSIST__FIELDS__SENTIMENT_ANALYSIS_INPUT__OPTIONS__LAST_INPUT__LABEL",
+                        value: "lastInput"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__SENTIMENT_ASSIST__FIELDS__SENTIMENT_ANALYSIS_INPUT__OPTIONS__LAST_TEN_INPUTS__LABEL",
+                        value: "lastTenInputs"
+                    },
+                ]
+            }
+        },
+    ],
+    sections: [],
+    form: [
+        { type: "field", key: "tileId" },
+        { type: "field", key: "sentimentAnalysisInput" },
+    ].filter((element) => !!element),
+    function: async (params) => {
+        const { cognigy, config } = params;
+        const { api } = cognigy;
+        const sentimentSelection = config.sentimentAnalysisInput;
+        try {
+            let prompt = "";
+            if (sentimentSelection === "lastInput") {
+                const curInput = cognigy.input.text;
+                prompt = `${constants_1.LAST_INPUT_PROMPT} ${curInput}`;
+            }
+            else if (sentimentSelection === "lastTenInputs") {
+                const conversation = (0, prompt_1.createLastUserInputString)(cognigy.lastConversationEntries) + "\n";
+                prompt = `A User had the following conversation with a bot: ${conversation}. Return the average sentiment of the conversation with one word. Use positive, neutral or negative only`;
+            }
+            const sentiment = await (0, sentiment_helper_1.sentimentAnalysis)(api, prompt);
+            const data = {
+                html: (0, sentimentAnalysisTemplate_1.default)(sentiment)
+            };
+            cognigy.api.sendTileUpdateToAgentAssistWorkspace(Object.assign(Object.assign({}, params), { tile: {
+                    id: config.tileId,
+                    type: "html",
+                    data,
+                } }));
+        }
+        catch (err) {
+            api.log("error", err);
+        }
+    }
+});
+//# sourceMappingURL=sentimentAssist.js.map

package/build/shared/charts/descriptors/agentAssist/setAdaptiveCardTile.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SET_ADAPTIVE_CARD_TILE = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+const cardKey = "card";
+const sampleAdaptiveCard = {
+    type: "AdaptiveCard",
+    version: "1.5",
+    body: [
+        {
+            type: "TextBlock",
+            text: "Hello World!",
+        },
+    ],
+};
+/**
+ * Node name: "setAdaptiveCardTile"
+ *
+ * Purpose:
+ * Set an Adaptive Card Tile for the Agent Assist Workspace
+ */
+exports.SET_ADAPTIVE_CARD_TILE = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "setAdaptiveCardTile",
+    defaultLabel: "Copilot: Adaptive Card Tile",
+    summary: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_TILE__SUMMARY",
+    appearance: {
+        showIcon: false,
+    },
+    tags: ["agentAssist"],
+    fields: [
+        {
+            key: "tileId",
+            label: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_TILE__TILE_ID__LABEL",
+            type: "cognigyText",
+            description: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_TILE__TILE_ID__DESCRIPTION",
+            params: {
+                required: true,
+            },
+            defaultValue: "card-tile",
+        },
+        {
+            key: cardKey,
+            label: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_TILE__CARD__LABEL",
+            type: "adaptivecard",
+            description: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_TILE__CARD__DESCRIPTION",
+            params: {
+                required: true,
+            },
+            defaultValue: sampleAdaptiveCard,
+        },
+    ],
+    sections: [],
+    form: [
+        { type: "field", key: "tileId" },
+        { type: "field", key: cardKey },
+    ].filter((element) => !!element),
+    function: async (params) => {
+        const { cognigy, config } = params;
+        const { api } = cognigy;
+        const card = config[cardKey];
+        if (!card || (card === null || card === void 0 ? void 0 : card.type) !== "AdaptiveCard") {
+            api.log("error", "A valid Adaptive card was not provided");
+            return;
+        }
+        cognigy.api.sendTileUpdateToAgentAssistWorkspace(Object.assign(Object.assign({}, params), { tile: {
+                id: config.tileId,
+                type: "card",
+                data: card,
+            } }));
+        return;
+    },
+});
+//# sourceMappingURL=setAdaptiveCardTile.js.map

package/build/shared/charts/descriptors/agentAssist/setAgentAssistGrid.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SET_AGENT_ASSIST_GRID = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+const sampleAgentAssistConfig = {
+    grid: {
+        columns: 5,
+        rows: 10,
+        gap: 5
+    },
+    tiles: {
+        'customer-sentiment': {
+            x: 1,
+            y: 1,
+            rows: 3,
+            columns: 2
+        },
+        'suggested-reply': {
+            x: 3,
+            y: 1,
+            rows: 3,
+            columns: 3
+        },
+        profile: {
+            x: 1,
+            y: 4,
+            rows: 3,
+            columns: 2
+        },
+        'user-history': {
+            x: 1,
+            y: 7,
+            rows: 4,
+            columns: 2
+        },
+        chat: {
+            x: 3,
+            y: 4,
+            rows: 7,
+            columns: 3
+        }
+    }
+};
+const checkAgentAssistKeys = (config) => {
+    const { grid, tiles } = config;
+    const configKeys = Object.keys(config);
+    const validKeys = ["grid", "tiles"];
+    const invalidKeys = configKeys.filter((key) => !validKeys.includes(key));
+    if (invalidKeys.length > 0 ||
+        configKeys.length > 2 ||
+        configKeys.length < 2) {
+        return false;
+    }
+    if (!grid || !tiles) {
+        return false;
+    }
+    const { columns, rows, gap } = grid;
+    if (!columns || !rows || !gap) {
+        return false;
+    }
+    return true;
+};
+const configKey = "agentAssistConfig";
+/**
+ * Node name: "setAgentAssistGrid"
+ *
+ * Purpose:
+ * Set the Agent Assist Grid configuration for the Agent Assist Workspace
+ */
+exports.SET_AGENT_ASSIST_GRID = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "setAgentAssistGrid",
+    defaultLabel: "Copilot: Set Grid",
+    summary: "UI__NODE_EDITOR__SET_AGENT_ASSIST_GRID__SUMMARY",
+    appearance: {
+        showIcon: false,
+    },
+    tags: ["agentAssist"],
+    fields: [
+        {
+            key: configKey,
+            label: "UI__NODE_EDITOR__SET_AGENT_ASSIST_GRID__CONFIG__LABEL",
+            type: "agentAssistConfig",
+            description: "UI__NODE_EDITOR__SET_AGENT_ASSIST_GRID__CONFIG__DESCRIPTION",
+            params: {
+                required: true,
+            },
+            defaultValue: sampleAgentAssistConfig
+        },
+    ],
+    sections: [],
+    form: [{ type: "field", key: configKey }].filter((element) => !!element),
+    function: async (params) => {
+        const { cognigy, config } = params;
+        const { api } = cognigy;
+        const agentAssistConfig = config[configKey];
+        if (!checkAgentAssistKeys(agentAssistConfig)) {
+            api.log("error", "A valid Agent Assist Grid configuration was not provided");
+            return;
+        }
+        cognigy.api.sendConfigUpdateToAgentAssistWorkspace(Object.assign(Object.assign({}, params), { agentAssistConfig }));
+        return;
+    },
+});
+//# sourceMappingURL=setAgentAssistGrid.js.map

package/build/shared/charts/descriptors/agentAssist/setHtmlTile.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SET_HTML_TILE = exports.formExampleHTML = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+const htmlContentKey = "htmlContent";
+const htmlJsonKey = "htmlJSON";
+exports.formExampleHTML = `<!DOCTYPE html>
+<html>
+  <head> </head>
+  <body>
+	<script>
+	  window.addEventListener("message", function (event) {
+		console.log("Content of message: " + event.data);
+	  });
+	</script>
+	<h1>HTML Tile</h1>
+  </body>
+</html>
+`;
+/**
+ * Node name: "setHTMLTile"
+ *
+ * Purpose:
+ * Set an HTML Tile for the Agent Assist Workspace
+ */
+exports.SET_HTML_TILE = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "setHTMLTile",
+    defaultLabel: "Copilot: HTML Tile",
+    summary: "UI__NODE_EDITOR__SET_HTML_TILE__SUMMARY",
+    appearance: {
+        showIcon: false,
+    },
+    tags: ["agentAssist"],
+    fields: [
+        {
+            key: "tileId",
+            label: "UI__NODE_EDITOR__SET_HTML_TILE__TILE_ID__LABEL",
+            type: "cognigyText",
+            description: "UI__NODE_EDITOR__SET_HTML_TILE__TILE_ID__DESCRIPTION",
+            defaultValue: "html-tile",
+            params: {
+                required: true,
+            },
+        },
+        {
+            key: htmlContentKey,
+            label: "UI__NODE_EDITOR__SET_HTML_TILE__HTML_CONTENT__LABEL",
+            type: "xml",
+            description: "UI__NODE_EDITOR__SET_HTML_TILE__HTML_CONTENT__DESCRIPTION",
+            defaultValue: exports.formExampleHTML,
+            params: {
+                required: true,
+            },
+        },
+        {
+            key: htmlJsonKey,
+            label: "UI__NODE_EDITOR__SET_HTML_TILE__HTML_JSON__LABEL",
+            type: "json",
+            description: "UI__NODE_EDITOR__SET_HTML_TILE__HTML_JSON__DESCRIPTION",
+            defaultValue: "{}",
+        },
+    ],
+    sections: [],
+    form: [
+        { type: "field", key: "tileId" },
+        { type: "field", key: "htmlContent" },
+        { type: "field", key: "htmlJSON" },
+    ].filter((element) => !!element),
+    function: async (params) => {
+        const { cognigy, config } = params;
+        const { api } = cognigy;
+        const htmlContent = config[htmlContentKey];
+        const jsonData = config[htmlJsonKey];
+        if (!config.htmlContent || config.htmlContent.length === 0) {
+            api.log("error", "Please provide HTML content in the HTML Content field");
+            return;
+        }
+        try {
+            const data = Object.assign({ html: htmlContent }, (jsonData.length > 0 && { metadata: JSON.parse(jsonData) }));
+            cognigy.api.sendTileUpdateToAgentAssistWorkspace(Object.assign(Object.assign({}, params), { tile: {
+                    id: config.tileId,
+                    type: "html",
+                    data,
+                } }));
+        }
+        catch (error) {
+            if (error instanceof SyntaxError) {
+                api.log("error", "Please provide a valid JSON in the JSON Data field");
+            }
+            else {
+                api.log("error", error);
+            }
+        }
+        return;
+    },
+});
+//# sourceMappingURL=setHtmlTile.js.map

package/build/shared/charts/descriptors/agentAssist/setIframeTile.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SET_IFRAME_TILE = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+const iframeUrlKey = "iframeUrl";
+const iframeJsonKey = "iframeJSON";
+const urlRegex = new RegExp(/^(https?:\/\/)?[\w\-]+(\.[\w\-]+)+[/#?]?.*$/i);
+/**
+ * Node name: "setIFrameTile"
+ *
+ * Purpose:
+ * Set an IFrame Tile for the Agent Assist Workspace
+ */
+exports.SET_IFRAME_TILE = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "setIFrameTile",
+    defaultLabel: "Copilot: IFrame Tile",
+    summary: "UI__NODE_EDITOR__SET_IFRAME_TILE__SUMMARY",
+    appearance: {
+        showIcon: false,
+    },
+    tags: ["agentAssist"],
+    fields: [
+        {
+            key: "tileId",
+            label: "UI__NODE_EDITOR__SET_IFRAME_TILE__TILE_ID__LABEL",
+            type: "cognigyText",
+            description: "UI__NODE_EDITOR__SET_IFRAME_TILE__TILE_ID__DESCRIPTION",
+            defaultValue: "iframe-tile",
+            params: {
+                required: true,
+            },
+        },
+        {
+            key: iframeUrlKey,
+            label: "UI__NODE_EDITOR__SET_IFRAME_TILE__IFRAME_URL__LABEL",
+            type: "cognigyText",
+            description: "UI__NODE_EDITOR__SET_IFRAME_TILE__IFRAME_URL__DESCRIPTION",
+            defaultValue: "https://www.test.example",
+            params: {
+                required: true,
+            },
+        },
+        {
+            key: iframeJsonKey,
+            label: "UI__NODE_EDITOR__SET_IFRAME_TILE__IFRAME_JSON__LABEL",
+            type: "json",
+            description: "UI__NODE_EDITOR__SET_IFRAME_TILE__IFRAME_JSON__DESCRIPTION",
+            defaultValue: "{}",
+        },
+    ],
+    sections: [],
+    form: [
+        { type: "field", key: "tileId" },
+        { type: "field", key: "iframeUrl" },
+        { type: "field", key: "iframeJSON" },
+    ].filter((element) => !!element),
+    function: async (params) => {
+        const { config, cognigy } = params;
+        const { api } = cognigy;
+        const url = config[iframeUrlKey];
+        const jsonData = config[iframeJsonKey];
+        if (!urlRegex.test(url)) {
+            api.log("error", "Please provide a valid URL in the IFrame URL field");
+            return;
+        }
+        try {
+            const data = Object.assign({ url }, (jsonData.length > 0 && { metadata: JSON.parse(jsonData) }));
+            cognigy.api.sendTileUpdateToAgentAssistWorkspace(Object.assign(Object.assign({}, params), { tile: {
+                    id: config.tileId,
+                    type: "iframe",
+                    data,
+                } }));
+        }
+        catch (error) {
+            if (error instanceof SyntaxError) {
+                api.log("error", "Please provide a valid JSON in the JSON Data field");
+            }
+            else {
+                api.log("error", error);
+            }
+        }
+        return;
+    },
+});
+//# sourceMappingURL=setIframeTile.js.map