npm - @cognigy/rest-api-client - Versions diffs - 0.13.1 → 0.14.0 - Mend

@cognigy/rest-api-client 0.13.1 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (110) hide show

package/build/shared/charts/descriptors/apps/setHtmlAppState.js CHANGED Viewed

@@ -3,18 +3,44 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SET_HTML_APP_STATE = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
-const getEasyHtmlValue = (body) => `<!DOCTYPE html>
+const getEasyHtmlValue = (body) => /* html */ `<!DOCTYPE html>
 <html lang="en">
 <head>
-	<script>
-	var d=Object.defineProperty;var c=(a,e,s)=>e in a?d(a,e,{enumerable:!0,configurable:!0,writable:!0,value:s}):a[e]=s;var t=(a,e,s)=>(c(a,typeof e!="symbol"?e+"":e,s),s);const u=a=>({__INTER_FRAME_SOCKET_MESSAGE:!0,appEvent:a}),l=(a,e)=>({type:a,payload:e}),h=a=>{var e;return!!((e=a.data)!=null&&e.__INTER_FRAME_SOCKET_MESSAGE)};class p{constructor(e,s){t(this,"unsubscribers",new Set);t(this,"emit",(e,s)=>{const n=l(e,s),o=u(n);this.targetWindow.postMessage(o,"*")});t(this,"on",(e,s)=>{const n=r=>{if(r.source===this.targetWindow&&!!h(r)&&r.data.appEvent.type===e)try{s(r.data.appEvent)}catch{}};this.sourceWindow.addEventListener("message",n);const o=()=>{this.sourceWindow.removeEventListener("message",n),this.unsubscribers.delete(o)};return this.unsubscribers.add(o),o});t(this,"once",(e,s)=>{const n=this.on(e,o=>{s(o),n()});return n});t(this,"cleanup",()=>{for(const e of this.unsubscribers)e()});this.sourceWindow=e,this.targetWindow=s}}class i{constructor(){t(this,"appTemplateData");t(this,"_ready",!1);t(this,"_loaded",!1);t(this,"_customReadyCheckRequested",!1);t(this,"_customReadyCheckDone",!1);t(this,"_appTemplateDataInitialized",!1);t(this,"socket",new p(window,window.parent));t(this,"sendReady",()=>{this._ready||(this.socket.emit("ready"),i.log("ready!"),this._ready=!0)});t(this,"doReadinessCheck",()=>{if(!this._ready){if(!this._appTemplateDataInitialized){i.log("not yet ready: initial app template data missing");return}if(!this._customReadyCheckRequested&&!this._loaded){i.log("not yet ready: page not loaded, yet");return}if(this._customReadyCheckRequested&&!this._customReadyCheckDone){i.log("not yet ready: custom readiness check not called");return}this.sendReady()}});t(this,"getCustomReadyHandler",()=>(i.log("switching to 'manual ready check'"),this._customReadyCheckRequested=!0,()=>{i.log("'manual ready check' done"),this._customReadyCheckDone=!0,this.doReadinessCheck()}));t(this,"onAppTemplateData",e=>this.socket.on("appTemplateData",s=>{e(s.payload)}));t(this,"getAppTemplateData",async()=>this._appTemplateDataInitialized?this.appTemplateData:new Promise(e=>{const s=this.onAppTemplateData(n=>{s(),e(n)})}));t(this,"submit",e=>{this.socket.emit("submit",e)});window.addEventListener("load",()=>{this._loaded=!0,this.doReadinessCheck()}),this.onAppTemplateData(e=>{this._appTemplateDataInitialized=!0,this.appTemplateData=e,i.log("received data from shell page",e),this.doReadinessCheck()}),this.socket.emit("sdk-loaded"),i.log("initialized")}static log(...e){console.log("[AppPageSDK]",...e)}}window.SDK=new i;
-	</script>
+	<!--
+			loads the App Page SDK, provided by Cognigy,
+			exposed as a global variable called "SDK".
+	-->
+	<script src="/sdk/app-page-sdk.js"></script>
+	<!--
+		Example: Form Submission
+		This example shows how you can use native HTML
+		form functionality to submit data from your App.
+		We're rendering a simple form with a text input
+		and a submit button.
+		The "name" attribute is important and will be used
+		to identify this field in the result!
+		Using this example, the end user can type a nickname
+		and submit it either via the button or by hitting "return".
+		The script will pick the first "form" element on the page
+		and configures it to submit its result via the "App Page SDK"
+	-->
+	<form>
+		<input name="nickname" placeholder="your nickname" />
+		<button>submit</button>
+	</form>
 	<script>
 		window.addEventListener("load", () => {
-			const form = document.querySelector('form');
-			form.onsubmit = e => {
-				e.preventDefault();
-				e.stopPropagation();
+			const form = document.querySelector('form');
+			form.onsubmit = e => {
+				e.preventDefault();
+				e.stopPropagation();
 				const formData = new FormData(form);
 				const values = [...formData.entries()].reduce((obj, [key, value]) => {
 					obj[key] = value;
@@ -25,18 +51,62 @@ const getEasyHtmlValue = (body) => `<!DOCTYPE html>
 			};
 		});
 	</script>
+	<!--
+		Example: Submitting fixed values
+		This example shows how to submit fixed values by clicking a button.
+		Clicking the "OK" button will submit { option: "ok" },
+		while clicking the "Cancel" button will submit { option: "cancel" }
+	-->
+	<!--
+		<button type="button" onclick="SDK.submit({ option: 'ok' })">OK</button>
+		<button type="button" onclick="SDK.submit({ option: 'cancel' })">Cancel</button>
+	-->
+	<!--
+		Example: Custom Readiness Handler
+		If your App Page needs to load additional resources
+		before being "ready", you can postpone the "readiness"
+		of your App Page with a "custom ready handler".
+		If you do this, the App Shell Page will show a "loading"
+		screen until you decide that this App Page is ready!
+		Beware: your App Page has 10 seconds to get ready,
+		otherwise it will be treated as "failed to load".
+	-->
+	<script>
+		const ready = SDK.getCustomReadyHandler();
+		// App Page "ready" after 2 seconds
+		setTimeout(() => {
+			ready();
+		}, 2000);
+	</script>
 </head>
 <body>
-${body}
+	${body}
 </body>
-</html>`;
-const defaultBody = `<form>
+</html>
+`;
+const defaultBody =
+/* html */
+`<form>
 	<input
 		name="nickname"
-		placeholder="your nickname"
+		placeholder="your nickname"
 	/>
 	<button>submit</button>
-</form>`;
+</form>
+`;
 const defaultFullHTMLDocument = getEasyHtmlValue("");
 /**
  * Node name: 'setHTMLAppState'
@@ -46,8 +116,8 @@ const defaultFullHTMLDocument = getEasyHtmlValue("");
  */
 exports.SET_HTML_APP_STATE = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "setHTMLAppState",
-    defaultLabel: "Set HTML App State",
-    summary: "Set the HTML Code of a Generic HTML App.",
+    defaultLabel: "Set HTML xApp State",
+    summary: "Set the HTML Code of a Generic HTML xApp.",
     appearance: {
         showIcon: false,
     },

package/build/shared/charts/descriptors/apps/utils/buildAppUrl.js ADDED Viewed

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildAppUrl = void 0;
+function buildAppUrl(baseUrl, appSessionToken, customization) {
+    let finalUrl = `${baseUrl}?token=${appSessionToken}`;
+    if (customization) {
+        finalUrl = `${finalUrl}&overrides=${encodeURIComponent(JSON.stringify(customization))}`;
+    }
+    return finalUrl;
+}
+exports.buildAppUrl = buildAppUrl;
+//# sourceMappingURL=buildAppUrl.js.map

package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderConnection.js ADDED Viewed

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AZURE_OPEAN_AI_PROVIDER_CONNECTION = void 0;
+exports.AZURE_OPEAN_AI_PROVIDER_CONNECTION = {
+    type: "AzureOpenAIProvider",
+    label: "A Connection to Azure Open.AI",
+    fields: [
+        { fieldName: "apiKey" },
+        { fieldName: "resourceName" },
+        { fieldName: "deploymentName" },
+        { fieldName: "apiVersion", required: false },
+    ]
+};
+//# sourceMappingURL=azureOpenAIProviderConnection.js.map

package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/index.js ADDED Viewed

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cognigyGenerativeAIProviderModule = exports.AZURE_OPEAN_AI_PROVIDER_CONNECTION = exports.OPEAN_AI_PROVIDER_CONNECTION = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+const openAIProviderConnection_1 = require("./openAIProviderConnection");
+const azureOpenAIProviderConnection_1 = require("./azureOpenAIProviderConnection");
+var openAIProviderConnection_2 = require("./openAIProviderConnection");
+Object.defineProperty(exports, "OPEAN_AI_PROVIDER_CONNECTION", { enumerable: true, get: function () { return openAIProviderConnection_2.OPEAN_AI_PROVIDER_CONNECTION; } });
+var azureOpenAIProviderConnection_2 = require("./azureOpenAIProviderConnection");
+Object.defineProperty(exports, "AZURE_OPEAN_AI_PROVIDER_CONNECTION", { enumerable: true, get: function () { return azureOpenAIProviderConnection_2.AZURE_OPEAN_AI_PROVIDER_CONNECTION; } });
+exports.cognigyGenerativeAIProviderModule = (0, createNodeDescriptor_1.createExtension)({
+    nodes: [],
+    connections: [
+        openAIProviderConnection_1.OPEAN_AI_PROVIDER_CONNECTION,
+        azureOpenAIProviderConnection_1.AZURE_OPEAN_AI_PROVIDER_CONNECTION
+    ]
+});
+//# sourceMappingURL=index.js.map

package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/openAIProviderConnection.js ADDED Viewed

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OPEAN_AI_PROVIDER_CONNECTION = void 0;
+exports.OPEAN_AI_PROVIDER_CONNECTION = {
+    type: "OpenAIProvider",
+    label: "A Connection to Open.AI",
+    fields: [
+        { fieldName: "apiKey" },
+    ]
+};
+//# sourceMappingURL=openAIProviderConnection.js.map

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cognigyInternalStorageProviderModule = exports.cognigyVoiceGateway2Module = exports.cognigyMicrosoftModule = exports.cognigyVoiceGatewayModule = exports.cognigySMTPModule = exports.cognigySQLModule = exports.cognigyMongoDBModule = exports.cognigyBasicModule = void 0;
+exports.cognigyGenerativeAIProviderModule = exports.cognigyInternalStorageProviderModule = exports.cognigyVoiceGateway2Module = exports.cognigyMicrosoftModule = exports.cognigyVoiceGatewayModule = exports.cognigySMTPModule = exports.cognigySQLModule = exports.cognigyMongoDBModule = exports.cognigyBasicModule = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../createNodeDescriptor");
 /* Nodes */
@@ -79,19 +79,20 @@ const nodes = [
     service_1.HANDOVER_V2,
     service_1.CHECK_AGENT_AVAILABILITY,
     service_1.HTTP_REQUEST,
+    service_1.COMPLETE_TEXT,
     service_1.TRIGGER_FUNCTION,
     service_1.ON_SCHEDULING_ERROR,
     service_1.ON_SCHEDULED,
     // REQUIRED_FIELDS,
-    //ALL_FIELDS,
+    // ALL_FIELDS,
     logic_1.ENABLE_SLOT_FILLERS,
-    logic_1.DISABLE_SLOT_FILLERS,
+    logic_1.DISABLE_SLOT_FILLERS
 ];
 if (process.env.FEATURE_USE_COGNIGY_LIVE_AGENT === "true") {
     nodes.push(liveAgent_1.ASSIST_INFO);
 }
 if (process.env.FEATURE_USE_COGNIGY_APPS === "true") {
-    nodes.push(apps_1.INIT_APP_SESSION, apps_1.SET_APP_STATE, apps_1.GET_APP_SESSION_PIN, apps_1.SET_HTML_APP_STATE, apps_1.SET_ADAPTIVE_CARD_APP_STATE);
+    nodes.push(apps_1.INIT_APP_SESSION, apps_1.GET_APP_SESSION_PIN, apps_1.SET_HTML_APP_STATE, apps_1.SET_ADAPTIVE_CARD_APP_STATE);
 }
 if (process.env.FEATURE_TMP_ENABLE_GENERIC_VOICE_NODES === "true") {
     nodes.push(voice_1.HANG_UP, voice_1.PLAY, voice_1.TRANSFER_VOICE, voice_1.BARGE_IN, voice_1.CONTINUOUS_ASR, voice_1.DTMF, voice_1.USER_INPUT_TIMEOUT, voice_1.SESSION_SPEECH_PARAMETERS);
@@ -108,8 +109,8 @@ exports.cognigyBasicModule = (0, createNodeDescriptor_1.createExtension)({
         service_1.HTTP_CONNECTION_BASIC,
         service_1.HTTP_CONNECTION_APIKEYAUTHKEY,
         service_1.HTTP_CONNECTION_APIKEYXKEY,
-        service_1.HTTP_CONNECTION_OAUTH2,
-    ],
+        service_1.HTTP_CONNECTION_OAUTH2
+    ]
 });
 var mongoDB_1 = require("./connectionNodes/mongoDB");
 Object.defineProperty(exports, "cognigyMongoDBModule", { enumerable: true, get: function () { return mongoDB_1.cognigyMongoDBModule; } });
@@ -125,4 +126,6 @@ var voicegateway2_1 = require("./voicegateway2");
 Object.defineProperty(exports, "cognigyVoiceGateway2Module", { enumerable: true, get: function () { return voicegateway2_1.cognigyVoiceGateway2Module; } });
 var internalStorageProviders_1 = require("./connectionNodes/internalStorageProviders");
 Object.defineProperty(exports, "cognigyInternalStorageProviderModule", { enumerable: true, get: function () { return internalStorageProviders_1.cognigyInternalStorageProviderModule; } });
+var generativeAIProviders_1 = require("./connectionNodes/generativeAIProviders");
+Object.defineProperty(exports, "cognigyGenerativeAIProviderModule", { enumerable: true, get: function () { return generativeAIProviders_1.cognigyGenerativeAIProviderModule; } });
 //# sourceMappingURL=index.js.map

package/build/shared/charts/descriptors/logic/switch/switch.js CHANGED Viewed

@@ -189,11 +189,12 @@ exports.SWITCH = (0, createNodeDescriptor_1.createNodeDescriptor)({
             }
         }
         const matchedCase = children === null || children === void 0 ? void 0 : children.find((child) => {
+            var _a, _b;
             if (child.type !== "case") {
                 return;
             }
             if (useStrict) {
-                return api.parseCognigyScriptText(`${child.config.case.value}`) === parsedOperator;
+                return api.parseCognigyScriptText(`${(_a = child.config.case.value) === null || _a === void 0 ? void 0 : _a.trim()}`) === parsedOperator;
             }
             else {
                 /**
@@ -203,7 +204,7 @@ exports.SWITCH = (0, createNodeDescriptor_1.createNodeDescriptor)({
                  * operator is a number. We do not support switching on
                  * objects
                  */
-                return `${api.parseCognigyScriptText(`${child.config.case.value}`)}` === `${parsedOperator}`;
+                return `${api.parseCognigyScriptText(`${(_b = child.config.case.value) === null || _b === void 0 ? void 0 : _b.trim()}`)}` === `${parsedOperator}`;
             }
         });
         if (matchedCase) {

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

@@ -6,6 +6,7 @@ const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 const evaluateQuestionAnswer_1 = require("./utils/evaluateQuestionAnswer");
 const say_1 = require("../say");
 const BaseContext_1 = require("../../../../helper/BaseContext");
+const getRephraseWithAIFields_1 = require("../../../helpers/generativeAI/getRephraseWithAIFields");
 exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "optionalQuestion",
     defaultLabel: "Optional Question",
@@ -77,11 +78,15 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
                         label: "Regex",
                         value: "regex",
                     },
+                    process.env.FEATURE_USE_COGNIGY_APPS && {
+                        label: "xApp",
+                        value: "app",
+                    },
                     {
                         label: "Data",
                         value: "data",
                     },
-                ],
+                ].filter(option => !!option),
             },
             defaultValue: "yesNo",
         },
@@ -174,8 +179,9 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 ]
             },
             defaultValue: "answer"
-        }
-    ],
+        },
+        ...(0, getRephraseWithAIFields_1.getRephraseWithAIFields)(),
+    ].filter(field => !!field),
     sections: [
         {
             key: "context",
@@ -197,8 +203,9 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 "retentionTime",
                 "cognigyScript"
             ]
-        }
-    ],
+        },
+        (0, getRephraseWithAIFields_1.getRephraseWithAISection)(),
+    ].filter(section => !!section),
     form: [
         { type: "field", key: "type" },
         { type: "field", key: "keyphraseTag" },
@@ -207,6 +214,7 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
         { type: "field", key: "say" },
         { type: "section", key: "advanced" },
         { type: "section", key: "context" },
+        { type: "section", key: "aiEnhancedOutput" },
     ],
     preview: {
         key: "say",
@@ -220,7 +228,7 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
         placement: {}
     },
     tags: ["basic", "message", "nlu"],
-    function: async ({ cognigy, config, childConfigs, nodeId }) => {
+    function: async ({ cognigy, config, childConfigs, nodeId, organisationId, }) => {
         const { say, retentionTime = 3, type, executeChildrenOnly, cognigyScript, storeResultInContext, contextKey } = config;
         const { regex: regexField } = config;
         const { keyphraseTag, usePositiveOnly } = config;
@@ -275,6 +283,9 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
                     condition = (usePositiveOnly) ? `input.slots['${keyphraseTag}'] && !!input.slots['${keyphraseTag}'].find(k => k.neg === false)` : `!!input.slots['${keyphraseTag}']`;
                     break;
                 }
+                case "app": {
+                    condition = `input.data?._cognigy?._app?.type === "submit"`;
+                }
             }
             const addConditionalEntrypointParams = {
                 entrypoint: nodeId,
@@ -285,7 +296,19 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 addConditionalEntrypointParams.cognigyScriptInput = input;
             }
             api.addConditionalEntrypoint(addConditionalEntrypointParams);
-            say_1.SAY.function({ cognigy, config: { say }, childConfigs: [], nodeId });
+            const rephraseWithAIParams = {
+                generativeAI_rephraseOutputMode: config.generativeAI_rephraseOutputMode,
+                generativeAI_temperature: config.generativeAI_temperature,
+                generativeAI_amountOfLastUserInputs: config.generativeAI_amountOfLastUserInputs,
+                generativeAI_customInputs: config.generativeAI_customInputs,
+                promtType: "question",
+                questionType: config.type,
+                question: undefined,
+                answer: undefined,
+            };
+            rephraseWithAIParams.promtType = "question";
+            rephraseWithAIParams.questionType = config.type;
+            await say_1.SAY.function({ cognigy, config: Object.assign({ say }, rephraseWithAIParams), childConfigs: [], nodeId, organisationId });
             if (onQuestionChild) {
                 api.setNextNode(onQuestionChild.id);
             }