@cognigy/rest-api-client 0.14.0 → 0.16.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 (334) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/build/GenericTusFn.js +64 -0
  3. package/build/RestAPIClient.js +7 -0
  4. package/build/apigroups/AdministrationAPIGroup_2_0.js +7 -2
  5. package/build/apigroups/AdministrationAPIGroup_2_1.js +13 -0
  6. package/build/apigroups/ResourcesAPIGroup_2_0.js +78 -13
  7. package/build/apigroups/TTusAPIOperation.js +3 -0
  8. package/build/apigroups/index.js +5 -1
  9. package/build/connector/AxiosAdapter.js +6 -5
  10. package/build/shared/api/eightByEight/eightByEightInterfaces.js +3 -0
  11. package/build/shared/charts/descriptors/agentAssist/constants/constants.js +7 -0
  12. package/build/shared/charts/descriptors/agentAssist/helpers/sentiment.helper.js +41 -0
  13. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/identityAssistTemplate.js +54 -0
  14. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/knowledgeAssistTemplate.js +187 -0
  15. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/nextActionWidgetTemplate.js +93 -0
  16. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stage0.js +81 -0
  17. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stage1.js +84 -0
  18. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stage2.js +97 -0
  19. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stageError.js +85 -0
  20. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/sentimentAnalysisTemplate.js +41 -0
  21. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/stylesPartial.js +15 -0
  22. package/build/shared/charts/descriptors/agentAssist/htmlTemplates/transcriptAssistTemplate.js +53 -0
  23. package/build/shared/charts/descriptors/agentAssist/identityAssist.js +135 -0
  24. package/build/shared/charts/descriptors/agentAssist/index.js +24 -0
  25. package/build/shared/charts/descriptors/agentAssist/knowledgeAssist.js +625 -0
  26. package/build/shared/charts/descriptors/agentAssist/nextActionAssist.js +77 -0
  27. package/build/shared/charts/descriptors/agentAssist/sentimentAssist.js +86 -0
  28. package/build/shared/charts/descriptors/agentAssist/setAdaptiveCardTile.js +74 -0
  29. package/build/shared/charts/descriptors/agentAssist/setAgentAssistGrid.js +105 -0
  30. package/build/shared/charts/descriptors/agentAssist/setHtmlTile.js +98 -0
  31. package/build/shared/charts/descriptors/agentAssist/setIframeTile.js +86 -0
  32. package/build/shared/charts/descriptors/agentAssist/setSecureFormsTile.js +171 -0
  33. package/build/shared/charts/descriptors/agentAssist/transcriptAssist.js +72 -0
  34. package/build/shared/charts/descriptors/allFields.js +6 -0
  35. package/build/shared/charts/descriptors/analytics/activateProfile.js +1 -1
  36. package/build/shared/charts/descriptors/analytics/blindMode.js +5 -5
  37. package/build/shared/charts/descriptors/analytics/completeGoal.js +2 -2
  38. package/build/shared/charts/descriptors/analytics/deactivateProfile.js +2 -2
  39. package/build/shared/charts/descriptors/analytics/deleteProfile.js +1 -1
  40. package/build/shared/charts/descriptors/analytics/mergeProfile.js +2 -2
  41. package/build/shared/charts/descriptors/analytics/overwriteAnalytics.js +34 -27
  42. package/build/shared/charts/descriptors/analytics/requestRating.js +5 -5
  43. package/build/shared/charts/descriptors/analytics/setRating.js +4 -4
  44. package/build/shared/charts/descriptors/analytics/updateProfile.js +3 -3
  45. package/build/shared/charts/descriptors/apps/getAppSessionPin.js +7 -14
  46. package/build/shared/charts/descriptors/apps/initAppSession.js +99 -87
  47. package/build/shared/charts/descriptors/apps/setAdaptiveCardAppState.js +101 -19
  48. package/build/shared/charts/descriptors/apps/setAppState.js +7 -7
  49. package/build/shared/charts/descriptors/apps/setHtmlAppState.js +141 -99
  50. package/build/shared/charts/descriptors/apps/utils/buildAppUrl.js +2 -6
  51. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/TGenerativeAIConnectionFields.js +3 -0
  52. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/alephAlphaProviderConnection.js +11 -0
  53. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/anthropicProviderConnection.js +11 -0
  54. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderConnection.js +4 -1
  55. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderConnectionV2.js +11 -0
  56. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/googleVertexAIProviderConnection.js +16 -0
  57. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/index.js +18 -2
  58. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/openAIProviderConnection.js +2 -2
  59. package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/amazonStorageProviderConnection.js +5 -5
  60. package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/azureBlobStorageProviderConnection.js +4 -4
  61. package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/googleCloudStorageProviderConnection.js +4 -4
  62. package/build/shared/charts/descriptors/connectionNodes/mongoDB/aggregate.js +13 -13
  63. package/build/shared/charts/descriptors/connectionNodes/mongoDB/find.js +18 -18
  64. package/build/shared/charts/descriptors/connectionNodes/mongoDB/findOne.js +17 -17
  65. package/build/shared/charts/descriptors/connectionNodes/mongoDB/insert.js +13 -13
  66. package/build/shared/charts/descriptors/connectionNodes/mongoDB/mongoDBConnection.js +2 -2
  67. package/build/shared/charts/descriptors/connectionNodes/mongoDB/remove.js +13 -13
  68. package/build/shared/charts/descriptors/connectionNodes/mongoDB/updateMany.js +15 -15
  69. package/build/shared/charts/descriptors/connectionNodes/mongoDB/updateOne.js +15 -15
  70. package/build/shared/charts/descriptors/connectionNodes/smtp/emailNotification.js +28 -28
  71. package/build/shared/charts/descriptors/connectionNodes/smtp/index.js +3 -1
  72. package/build/shared/charts/descriptors/connectionNodes/smtp/oAuth2Connection.js +18 -0
  73. package/build/shared/charts/descriptors/connectionNodes/smtp/sendEmail.js +102 -70
  74. package/build/shared/charts/descriptors/connectionNodes/smtp/serviceConnection.js +3 -3
  75. package/build/shared/charts/descriptors/connectionNodes/smtp/smtpConnection.js +6 -6
  76. package/build/shared/charts/descriptors/connectionNodes/speechProviders/awsSpeechProviderConnection.js +14 -0
  77. package/build/shared/charts/descriptors/connectionNodes/speechProviders/googleSpeechProviderConnection.js +16 -0
  78. package/build/shared/charts/descriptors/connectionNodes/speechProviders/index.js +23 -0
  79. package/build/shared/charts/descriptors/connectionNodes/speechProviders/microsoftSpeechProviderConnection.js +12 -0
  80. package/build/shared/charts/descriptors/connectionNodes/sql/runQuery.js +11 -11
  81. package/build/shared/charts/descriptors/connectionNodes/sql/runStoredProcedure.js +13 -13
  82. package/build/shared/charts/descriptors/connectionNodes/sql/runTransaction.js +11 -11
  83. package/build/shared/charts/descriptors/connectionNodes/sql/sqlConnection.js +6 -6
  84. package/build/shared/charts/descriptors/connectionNodes/translationProviders/deeplTranslationProviderConnection.js +15 -0
  85. package/build/shared/charts/descriptors/connectionNodes/translationProviders/googleTranslationProviderConnection.js +15 -0
  86. package/build/shared/charts/descriptors/connectionNodes/translationProviders/index.js +23 -0
  87. package/build/shared/charts/descriptors/connectionNodes/translationProviders/microsoftTranslationProviderConnection.js +21 -0
  88. package/build/shared/charts/descriptors/data/addToContext.js +7 -7
  89. package/build/shared/charts/descriptors/data/code.js +3 -3
  90. package/build/shared/charts/descriptors/data/copyDataToContext.js +1 -1
  91. package/build/shared/charts/descriptors/data/copySlotsToContext.js +9 -9
  92. package/build/shared/charts/descriptors/data/log.js +7 -7
  93. package/build/shared/charts/descriptors/data/removeFromContext.js +7 -7
  94. package/build/shared/charts/descriptors/data/resetContext.js +2 -2
  95. package/build/shared/charts/descriptors/index.js +47 -12
  96. package/build/shared/charts/descriptors/knowledgeSearch/constants/constants.js +6 -0
  97. package/build/shared/charts/descriptors/knowledgeSearch/index.js +10 -0
  98. package/build/shared/charts/descriptors/knowledgeSearch/knowledgeSearch.js +154 -0
  99. package/build/shared/charts/descriptors/knowledgeSearch/knowledgeSearchV2.js +151 -0
  100. package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +985 -0
  101. package/build/shared/charts/descriptors/liveAgent/assistInfo.js +25 -25
  102. package/build/shared/charts/descriptors/logic/disableSlotFillers.js +4 -4
  103. package/build/shared/charts/descriptors/logic/enableSlotFillers.js +3 -3
  104. package/build/shared/charts/descriptors/logic/executeFlow.js +9 -9
  105. package/build/shared/charts/descriptors/logic/goTo.js +20 -18
  106. package/build/shared/charts/descriptors/logic/if/if.js +3 -3
  107. package/build/shared/charts/descriptors/logic/interval/interval.js +3 -3
  108. package/build/shared/charts/descriptors/logic/once/once.js +1 -1
  109. package/build/shared/charts/descriptors/logic/resetState.js +1 -1
  110. package/build/shared/charts/descriptors/logic/setState.js +4 -4
  111. package/build/shared/charts/descriptors/logic/setTranslation.js +15 -15
  112. package/build/shared/charts/descriptors/logic/sleep.js +2 -2
  113. package/build/shared/charts/descriptors/logic/stop.js +1 -1
  114. package/build/shared/charts/descriptors/logic/switch/case.js +1 -1
  115. package/build/shared/charts/descriptors/logic/switch/default.js +1 -1
  116. package/build/shared/charts/descriptors/logic/switch/switch.js +28 -19
  117. package/build/shared/charts/descriptors/logic/switchLocale.js +5 -5
  118. package/build/shared/charts/descriptors/logic/think.js +11 -11
  119. package/build/shared/charts/descriptors/logic/thinkV2.js +11 -11
  120. package/build/shared/charts/descriptors/logic/wait.js +1 -1
  121. package/build/shared/charts/descriptors/message/checkChannelChange/checkChannelChange.js +4 -4
  122. package/build/shared/charts/descriptors/message/datePicker.js +1 -1
  123. package/build/shared/charts/descriptors/message/question/optionalQuestion.js +68 -36
  124. package/build/shared/charts/descriptors/message/question/question.js +796 -210
  125. package/build/shared/charts/descriptors/message/question/utils/cleanTextUtils.js +191 -0
  126. package/build/shared/charts/descriptors/message/question/utils/datepickerUtils.js +40 -40
  127. package/build/shared/charts/descriptors/message/question/utils/evaluateQuestionAnswer.js +37 -27
  128. package/build/shared/charts/descriptors/message/say.js +37 -4
  129. package/build/shared/charts/descriptors/message/sendImage.js +1 -1
  130. package/build/shared/charts/descriptors/message/sendText.js +2 -2
  131. package/build/shared/charts/descriptors/microsoft/getToken.js +1 -1
  132. package/build/shared/charts/descriptors/microsoft/invalidateToken.js +1 -1
  133. package/build/shared/charts/descriptors/microsoft/tokenStatus/index.js +1 -1
  134. package/build/shared/charts/descriptors/nlu/addLexiconKeyphrase.js +5 -5
  135. package/build/shared/charts/descriptors/nlu/cleanText.js +104 -0
  136. package/build/shared/charts/descriptors/nlu/executeCognigyNLU.js +15 -15
  137. package/build/shared/charts/descriptors/nlu/extractAnswer.js +11 -11
  138. package/build/shared/charts/descriptors/nlu/fuzzySearch.js +33 -33
  139. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/generativeSlotFiller.js +270 -0
  140. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/generativeSlotFillerFallback.js +27 -0
  141. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/generativeSlotFillerSuccess.js +27 -0
  142. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +174 -0
  143. package/build/shared/charts/descriptors/nlu/index.js +9 -1
  144. package/build/shared/charts/descriptors/nlu/matchPattern.js +16 -16
  145. package/build/shared/charts/descriptors/nlu/regexSlotFiller.js +5 -5
  146. package/build/shared/charts/descriptors/placeholder.js +3 -3
  147. package/build/shared/charts/descriptors/service/GPTConversation.js +780 -0
  148. package/build/shared/charts/descriptors/service/GPTPrompt.js +394 -0
  149. package/build/shared/charts/descriptors/service/checkAgentAvailability.js +48 -33
  150. package/build/shared/charts/descriptors/service/closeHandover.js +34 -0
  151. package/build/shared/charts/descriptors/service/conversationSummary.js +148 -0
  152. package/build/shared/charts/descriptors/service/handover.js +18 -17
  153. package/build/shared/charts/descriptors/service/handoverInactivityTimer.js +37 -0
  154. package/build/shared/charts/descriptors/service/handoverV2.js +179 -51
  155. package/build/shared/charts/descriptors/service/httpRequest.js +52 -52
  156. package/build/shared/charts/descriptors/service/index.js +11 -3
  157. package/build/shared/charts/descriptors/service/triggerFunction/triggerFunction.js +3 -3
  158. package/build/shared/charts/descriptors/voice/index.js +5 -1
  159. package/build/shared/{interfaces/twilioInterface.js → charts/descriptors/voice/interface/IBandwidth.js} +1 -1
  160. package/build/shared/charts/descriptors/voice/mappers/base.mapper.js +97 -0
  161. package/build/shared/charts/descriptors/voice/mappers/hangup.mapper.js +32 -9
  162. package/build/shared/charts/descriptors/voice/mappers/muteSpeechInput.mapper.js +67 -0
  163. package/build/shared/charts/descriptors/voice/mappers/play.mapper.js +73 -19
  164. package/build/shared/charts/descriptors/voice/mappers/record.mapper.js +103 -0
  165. package/build/shared/charts/descriptors/voice/mappers/sendMetadata.mapper.js +68 -0
  166. package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +158 -66
  167. package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +68 -16
  168. package/build/shared/charts/descriptors/voice/nodes/bargeIn.js +14 -20
  169. package/build/shared/charts/descriptors/voice/nodes/continuousAsr.js +7 -7
  170. package/build/shared/charts/descriptors/voice/nodes/dtmf.js +10 -18
  171. package/build/shared/charts/descriptors/voice/nodes/hangup.js +2 -2
  172. package/build/shared/charts/descriptors/voice/nodes/muteSpeechInput.js +52 -0
  173. package/build/shared/charts/descriptors/voice/nodes/noUserInput.js +15 -14
  174. package/build/shared/charts/descriptors/voice/nodes/play.js +13 -9
  175. package/build/shared/charts/descriptors/voice/nodes/sendMetadata.js +51 -0
  176. package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +199 -21
  177. package/build/shared/charts/descriptors/voice/nodes/transfer.js +21 -13
  178. package/build/shared/charts/descriptors/voice/utils/vgConstants.js +14 -0
  179. package/build/shared/charts/descriptors/voicegateway/index.js +14 -11
  180. package/build/shared/charts/descriptors/voicegateway/nodes/agentAssist.js +10 -10
  181. package/build/shared/charts/descriptors/voicegateway/nodes/callRecording.js +64 -62
  182. package/build/shared/charts/descriptors/voicegateway/nodes/handover.js +14 -14
  183. package/build/shared/charts/descriptors/voicegateway/nodes/hangup.js +2 -2
  184. package/build/shared/charts/descriptors/voicegateway/nodes/playURL.js +18 -15
  185. package/build/shared/charts/descriptors/voicegateway/nodes/sendMessage.js +41 -41
  186. package/build/shared/charts/descriptors/voicegateway/nodes/sendMetaData.js +15 -19
  187. package/build/shared/charts/descriptors/voicegateway/nodes/setSessionParams.js +3 -3
  188. package/build/shared/charts/descriptors/voicegateway/utils/paramUtils.js +113 -97
  189. package/build/shared/charts/descriptors/voicegateway2/index.js +5 -1
  190. package/build/shared/charts/descriptors/voicegateway2/nodes/dtmf.js +5 -5
  191. package/build/shared/charts/descriptors/voicegateway2/nodes/hangup.js +3 -4
  192. package/build/shared/charts/descriptors/voicegateway2/nodes/muteSpeechInput.js +60 -0
  193. package/build/shared/charts/descriptors/voicegateway2/nodes/play.js +42 -18
  194. package/build/shared/charts/descriptors/voicegateway2/nodes/record.js +108 -0
  195. package/build/shared/charts/descriptors/voicegateway2/nodes/refer.js +9 -10
  196. package/build/shared/charts/descriptors/voicegateway2/nodes/sendMetadata.js +14 -29
  197. package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +424 -74
  198. package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +410 -45
  199. package/build/shared/charts/descriptors/voicegateway2/utils/helper.js +33 -7
  200. package/build/shared/charts/descriptors/voicegateway2/utils/strip-nulls.js +4 -0
  201. package/build/shared/charts/helpers/generativeAI/getRephraseWithAIFields.js +8 -8
  202. package/build/shared/charts/helpers/generativeAI/rephraseSentenceWithAi.js +1 -1
  203. package/build/shared/constants.js +18 -1
  204. package/build/shared/errors/ErrorCode.js +1 -0
  205. package/build/shared/errors/TooManyRequestsError.js +59 -0
  206. package/build/shared/errors/baseError.js +6 -2
  207. package/build/shared/errors/codes.js +2 -1
  208. package/build/shared/errors/index.js +3 -1
  209. package/build/shared/handoverClients/interfaces/THandoverEventType.js +3 -1
  210. package/build/shared/helper/BaseContext.js +43 -3
  211. package/build/shared/helper/nlu/dicts/dicts.js +691 -0
  212. package/build/shared/helper/nlu/textCleaner.js +413 -0
  213. package/build/shared/interfaces/IApiKey.js +2 -7
  214. package/build/shared/interfaces/IEndpointTranslationSettings.js +9 -0
  215. package/build/shared/interfaces/IOrganisation.js +4 -8
  216. package/build/shared/interfaces/IProfileSchema.js +1 -7
  217. package/build/shared/interfaces/agentAssist/ISendConfigUpdateParams.js +3 -0
  218. package/build/shared/interfaces/agentAssist/ISendTileUpdateParams.js +3 -0
  219. package/build/shared/interfaces/agentAssist/ISendUpdateReferenceParams.js +3 -0
  220. package/build/shared/interfaces/agentAssist/index.js +3 -0
  221. package/build/shared/interfaces/ai.js +0 -16
  222. package/build/shared/interfaces/amqpInterface.js +25 -23
  223. package/build/shared/interfaces/channels/genesysBotConnector.js +21 -0
  224. package/build/shared/interfaces/channels/niceCXOne.js +8 -0
  225. package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +80 -0
  226. package/build/shared/interfaces/generativeAI/IGenerativeAIPrompts.js +3 -0
  227. package/build/shared/interfaces/generativeAI/IRunGenerativeAIPromptOptions.js +3 -0
  228. package/build/shared/interfaces/handover.js +70 -4
  229. package/build/shared/interfaces/journeys/IJourney.js +6 -0
  230. package/build/shared/interfaces/journeys/IJourneyTrackEvent.js +2 -0
  231. package/build/shared/interfaces/knowledgesearch/search.js +3 -0
  232. package/build/shared/interfaces/messageAPI/ai.js +2 -1
  233. package/build/shared/interfaces/messageAPI/endpoints.js +177 -5
  234. package/build/shared/interfaces/messageAPI/handover.js +4 -1
  235. package/build/shared/interfaces/resources/IAgentAssistConfig.js +26 -20
  236. package/build/shared/interfaces/resources/IAuditEvent.js +9 -1
  237. package/build/shared/interfaces/resources/IChart.js +1 -10
  238. package/build/shared/interfaces/resources/IConnection.js +7 -1
  239. package/build/shared/interfaces/resources/IConnectionSchema.js +3 -0
  240. package/build/shared/interfaces/resources/IEndpoint.js +3 -14
  241. package/build/shared/interfaces/resources/IExtension.js +3 -0
  242. package/build/shared/interfaces/resources/IFlow.js +15 -10
  243. package/build/shared/interfaces/resources/IFunction.js +1 -7
  244. package/build/shared/interfaces/resources/IGenerateNodeOutput.js +3 -0
  245. package/build/shared/interfaces/resources/ILargeLanguageModel.js +73 -0
  246. package/build/shared/interfaces/resources/ILexicon.js +2 -7
  247. package/build/shared/interfaces/resources/INodeDescriptorSet.js +55 -30
  248. package/build/shared/interfaces/resources/IPackage.js +1 -7
  249. package/build/shared/interfaces/resources/IPlaybookRun.js +2 -1
  250. package/build/shared/interfaces/resources/IProject.js +1 -7
  251. package/build/shared/interfaces/resources/ISnapshot.js +2 -14
  252. package/build/shared/interfaces/resources/TNLUConnectorType.js +2 -2
  253. package/build/shared/interfaces/resources/TResourceType.js +16 -5
  254. package/build/shared/interfaces/resources/TRestChannelType.js +16 -11
  255. package/build/shared/interfaces/resources/TWebhookChannelType.js +6 -1
  256. package/build/shared/interfaces/resources/chart/IChartExecutable.js +1 -7
  257. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeChunk.js +50 -0
  258. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeSource.js +42 -0
  259. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeStore.js +26 -0
  260. package/build/shared/interfaces/resources/settings/IAgentSettings.js +7 -70
  261. package/build/shared/interfaces/resources/settings/IAudioPreviewSettings.js +36 -0
  262. package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js +25 -88
  263. package/build/shared/interfaces/resources/settings/IGenerativeAIUseCase.js +3 -0
  264. package/build/shared/interfaces/resources/settings/ISharedSettings.js +2 -2
  265. package/build/shared/interfaces/resources/settings/ITranslationSettings.js +63 -0
  266. package/build/shared/interfaces/resources/settings/index.js +7 -5
  267. package/build/shared/interfaces/restAPI/administration/user/v2.1/IApiKeyIndexItem_2_1.js +3 -0
  268. package/build/shared/interfaces/restAPI/administration/user/v2.1/IApiKey_2_1.js +3 -0
  269. package/build/shared/interfaces/restAPI/administration/user/v2.1/ICreateApiKeyRest_2_1.js +3 -0
  270. package/build/shared/interfaces/restAPI/administration/user/v2.1/IIndexApiKeysMeRest_2_1.js +3 -0
  271. package/build/shared/interfaces/restAPI/administration/user/v2.1/index.js +3 -0
  272. package/build/shared/interfaces/restAPI/administration/voiceGateway/v2.0/IReadVoiceGatewayAccountRest_2_0.js +3 -0
  273. package/build/shared/interfaces/restAPI/administration/voiceGateway/v2.0/ISetupVoiceGatewayAccountRest_2_0.js +3 -0
  274. package/build/shared/interfaces/restAPI/administration/voiceGateway/v2.0/index.js +3 -0
  275. package/build/shared/interfaces/restAPI/insights/reports/IGenerateReportRest_2_0.js +0 -2
  276. package/build/shared/interfaces/restAPI/metrics/knowledgeQueryCounter/v2.0/IGetKnowledgeQueryCounterOrganisationRest_2_0.js +3 -0
  277. package/build/shared/interfaces/restAPI/metrics/knowledgeQueryCounter/v2.0/IGetKnowledgeQueryCounterRest_2_0.js +3 -0
  278. package/build/shared/interfaces/restAPI/metrics/knowledgeQueryCounter/v2.0/IKnowlegeQueryCounterAggregatedValue_2_0.js +3 -0
  279. package/build/shared/interfaces/restAPI/metrics/knowledgeQueryCounter/v2.0/index.js +3 -0
  280. package/build/shared/interfaces/restAPI/resources/agentAssist/v2.0/IReadAgentAssistSessionDataRest_2_0.js +3 -0
  281. package/build/shared/interfaces/restAPI/resources/chart/v2.0/IGenerateNodeOutputRest_2_0.js +3 -0
  282. package/build/shared/interfaces/restAPI/resources/knowledgeSearchIndex/v2.0/ICreateKnowledgeSearchIndexRest_2_0.js +3 -0
  283. package/build/shared/interfaces/restAPI/resources/knowledgeSearchIndex/v2.0/IDeleteKnowledgeSearchIndexRest_2_0.js +3 -0
  284. package/build/shared/interfaces/restAPI/resources/knowledgeSearchIndex/v2.0/index.js +3 -0
  285. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/ICreateKnowledgeStoreRest_2_0.js +3 -0
  286. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/IDeleteKnowledgeStoreRest_2_0.js +3 -0
  287. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/IIndexKnowledgeStoresRest_2_0.js +3 -0
  288. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/IIngestKnowledgeStoreRest_2_0.js +3 -0
  289. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/IKnowledgeStore_2_0.js +3 -0
  290. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/IReadKnowledgeStoreRest_2_0.js +3 -0
  291. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/IUpdateKnowledgeStoreRest_2_0.js +3 -0
  292. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/index.js +3 -0
  293. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/source/ICreateKnowledgeSourceRest_2_0.js +3 -0
  294. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/source/IDeleteKnowledgeSourceRest_2_0.js +3 -0
  295. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/source/IIndexKnowledgeSourcesRest_2_0.js +3 -0
  296. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/source/IKnowledgeSource_2_0.js +3 -0
  297. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/source/IReadKnowledgeSourceRest_2_0.js +3 -0
  298. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/source/IUpdateKnowledgeSourceRest_2_0.js +3 -0
  299. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/source/IUploadKnowledgeSourceFileRest_2_0.js +4 -0
  300. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/source/chunk/ICreateKnowledgeChunkRest_2_0.js +3 -0
  301. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/source/chunk/IDeleteKnowledgeChunkRest_2_0.js +3 -0
  302. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/source/chunk/IIndexKnowledgeChunksRest_2_0.js +3 -0
  303. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/source/chunk/IKnowledgeChunk_2_0.js +3 -0
  304. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/source/chunk/IReadKnowledgeChunkRest_2_0.js +3 -0
  305. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/source/chunk/IUpdateKnowledgeChunkRest_2_0.js +3 -0
  306. package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/ICloneLargeLanguageModelRest_2_0.js +4 -0
  307. package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/ICreateLargeLanguageModelRest_2_0.js +3 -0
  308. package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/IDeleteLargeLanguageModelRest_2_0.js +3 -0
  309. package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/IIndexLargeLanguageModelsRest_2_0.js +3 -0
  310. package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/ILargeLanguageModelIndexItem_2_0.js +3 -0
  311. package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/ILargeLanguageModel_2_0.js +3 -0
  312. package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/IReadLargeLanguageModelRest_2_0.js +3 -0
  313. package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/ITestLargeLanguageModelRest_2_0.js +3 -0
  314. package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/IUpdateLargeLanguageModelRest_2_0.js +3 -0
  315. package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/index.js +3 -0
  316. package/build/shared/interfaces/restAPI/resources/nluconnector/v2.0/TNLUConnectorType_2_0.js +3 -3
  317. package/build/shared/interfaces/restAPI/resources/project/v2.0/settings/ISetupCognigyGenerativeAIRest_2_0.js +4 -0
  318. package/build/shared/interfaces/restAPI/resources/uploadResumable/v2.0/IUploadResumableRest_2_0.js +17 -0
  319. package/build/shared/interfaces/restAPI/resources/uploadResumable/v2.0/index.js +3 -0
  320. package/build/shared/interfaces/security/IACL.js +1 -7
  321. package/build/shared/interfaces/security/IIdentityProvider.js +1 -7
  322. package/build/shared/interfaces/security/IKnowledgeQueryCounterAggregatedValue.js +3 -0
  323. package/build/shared/interfaces/security/IPermission.js +8 -2
  324. package/build/shared/interfaces/security/IRole.js +6 -2
  325. package/build/shared/interfaces/security/index.js +1 -2
  326. package/build/shared/interfaces/taskmanager/ITask.js +1 -0
  327. package/build/shared/interfaces/trainer/ITrainerRecord.js +1 -1
  328. package/build/shared/interfaces/user.js +1 -9
  329. package/build/test.js +27 -0
  330. package/package.json +19 -17
  331. package/types/index.d.ts +10428 -8487
  332. package/build/shared/charts/descriptors/service/completeText.js +0 -316
  333. package/build/shared/charts/descriptors/voice/utils/constants.js +0 -8
  334. package/build/shared/charts/descriptors/voicegateway2/utils/constants.js +0 -7
@@ -11,30 +11,23 @@ const createNodeDescriptor_1 = require("../../createNodeDescriptor");
11
11
  */
12
12
  exports.GET_APP_SESSION_PIN = (0, createNodeDescriptor_1.createNodeDescriptor)({
13
13
  type: "getAppSessionPin",
14
- defaultLabel: "Get xApp Session PIN",
15
- summary: "Get a new xApp Session PIN.",
14
+ defaultLabel: "xApp: Get Session PIN",
15
+ summary: "UI__NODE_EDITOR__GET_APP_SESSION_PIN__SUMMARY",
16
16
  appearance: {
17
17
  showIcon: false,
18
18
  },
19
19
  fields: [],
20
- tags: ["basic", "apps"],
20
+ tags: ["basic", "apps", "xApps"],
21
21
  tokens: [
22
22
  {
23
23
  type: "input",
24
- label: "xApp Session PIN",
25
- script: "input.apps.session.pin || ''"
24
+ label: "UI__NODE_EDITOR__GET_APP_SESSION_PIN__TOKEN_XAPP_SESSION_PIN__LABEL",
25
+ script: "input.apps.session.pin",
26
26
  },
27
27
  {
28
28
  type: "input",
29
- label: "xApp PIN Page URL",
30
- script: `
31
- (() => {
32
- if (!input.apps.baseUrl) return '';
33
- const overrides = input.apps.customization ? \`?overrides=\${encodeURIComponent(JSON.stringify(input.apps.customization))}\` : '';
34
- return [input.apps.baseUrl, overrides].join('');
35
- })()`
36
- .split("\n")
37
- .join(" "),
29
+ label: "UI__NODE_EDITOR__GET_APP_SESSION_PIN__TOKEN_XAPP_PIN_PAGE_URL__LABEL",
30
+ script: "input.apps.baseUrl",
38
31
  },
39
32
  ],
40
33
  function: async ({ cognigy }) => {
@@ -12,8 +12,8 @@ const buildAppUrl_1 = require("./utils/buildAppUrl");
12
12
  */
13
13
  exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
14
14
  type: "initAppSession",
15
- defaultLabel: "Init xApp Session",
16
- summary: "Initializes a new xApp Session.",
15
+ defaultLabel: "xApp: Init Session",
16
+ summary: "UI__NODE_EDITOR__INIT_APP_SESSION__SUMMARY",
17
17
  appearance: {
18
18
  showIcon: false,
19
19
  },
@@ -22,32 +22,32 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
22
22
  {
23
23
  type: "cognigyText",
24
24
  key: "backgroundColor",
25
- label: "Background Color",
26
- description: "This color will be displayed in the background of all Shell Page Screens. Supports CSS background-color values (e.g. hex, hsl+a, rgb+a)",
25
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__BACKGROUND_COLOR__LABEL",
26
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__BACKGROUND_COLOR__DESCRIPTION",
27
27
  },
28
28
  {
29
29
  type: "cognigyText",
30
30
  key: "textColor",
31
- label: "Text Color",
32
- description: "This color will be used for textual content on all Shell Page Screens. Supports CSS color values (e.g. hex, hsl+a, rgb+a). Make sure to have a high contrast to the background color!",
31
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__TEXT_COLOR__LABEL",
32
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__TEXT_COLOR__DESCRIPTION",
33
33
  },
34
34
  {
35
35
  type: "select",
36
36
  key: "logo",
37
- label: "Logo",
38
- description: "Decides whether the default logo, no logo or a custom logo should be used on the Shell Page Screens.",
37
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__LOGO__LABEL",
38
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__LOGO__DESCRIPTION",
39
39
  params: {
40
40
  options: [
41
41
  {
42
- label: "Show Default Logo",
42
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__LOGO__DEFAULT__LABEL",
43
43
  value: "default",
44
44
  },
45
45
  {
46
- label: "Don't show a Logo",
46
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__LOGO__NONE__LABEL",
47
47
  value: "none",
48
48
  },
49
49
  {
50
- label: "Show custom Logo",
50
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__LOGO__CUSTOM__LABEL",
51
51
  value: "custom",
52
52
  },
53
53
  ],
@@ -57,31 +57,30 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
57
57
  {
58
58
  type: "cognigyText",
59
59
  key: "logoUrl",
60
- label: "Custom Logo URL",
61
- description: "A valid image URL for the custom logo. Make sure to choose a logo that is distinguishable from the background color, especially when using transparency in the logo!",
60
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__LOGO_URL__LABEL",
61
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__LOGO_URL__DESCRIPTION",
62
62
  condition: {
63
63
  key: "logo",
64
64
  value: "custom",
65
65
  },
66
66
  },
67
- // PIN Screen
68
67
  {
69
68
  type: "cognigyText",
70
- key: "pinEnterPinText",
71
- label: "'Enter PIN' Text",
72
- description: "This text asks the user to enter the xApp Session PIN.",
73
- },
74
- {
75
- type: "cognigyText",
76
- key: "pinIncorrectText",
77
- label: "'Pin Incorrect' Text",
78
- description: "This text tells the user that the entered PIN was incorrect.",
69
+ key: "faviconUrl",
70
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__FAVICON_URL__LABEL",
71
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__FAVICON_URL__DESCRIPTION",
72
+ params: {
73
+ maxLength: 256,
74
+ },
79
75
  },
80
76
  {
81
77
  type: "cognigyText",
82
- key: "pinUnavailableText",
83
- label: "'Unavailable' Text",
84
- description: "This text tells the user that the application is not available right now.",
78
+ key: "pageTitle",
79
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__PAGE_TITLE__LABEL",
80
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__PAGE_TITLE__DESCRIPTION",
81
+ params: {
82
+ maxLength: 256,
83
+ },
85
84
  },
86
85
  // App Pages
87
86
  {
@@ -89,26 +88,35 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
89
88
  key: "appSectionDescription",
90
89
  label: " ",
91
90
  params: {
92
- text: "This section is used to customize content related to the 'xApp Screen' sections (Active xApp + xApp Overrides).",
91
+ text: "UI__NODE_EDITOR__INIT_APP_SESSION__APP_SECTION_DESCRIPTION__TEXT",
93
92
  },
94
93
  },
95
94
  {
96
95
  type: "cognigyText",
97
96
  key: "appLoadingText",
98
- label: "'Loading' Text",
99
- description: "This text is shown on the 'Loading Screen' when an xApp Page is launched.",
97
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__APP_LOADING_TEXT__LABEL",
98
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__APP_LOADING_TEXT__DESCRIPTION",
99
+ params: {
100
+ maxLength: 256,
101
+ },
100
102
  },
101
103
  {
102
104
  type: "cognigyText",
103
105
  key: "appLaunchErrorText",
104
- label: "'Launch Error' Text",
105
- description: "This text is shown when an xApp Page fails to load for any reason.",
106
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__APP_LAUNCH_ERROR_TEXT__LABEL",
107
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__APP_LAUNCH_ERROR_TEXT__DESCRIPTION",
108
+ params: {
109
+ maxLength: 256,
110
+ },
106
111
  },
107
112
  {
108
113
  type: "cognigyText",
109
114
  key: "appErrorText",
110
- label: "'xApp Error' Text",
111
- description: "This text is shown when an xApp Page encounters an Error and is halted.",
115
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__APP_ERROR_TEXT__LABEL",
116
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__APP_ERROR_TEXT__DESCRIPTION",
117
+ params: {
118
+ maxLength: 256,
119
+ },
112
120
  },
113
121
  // Intermediate Screen
114
122
  {
@@ -116,25 +124,25 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
116
124
  key: "intermediateScreenDescription",
117
125
  label: " ",
118
126
  params: {
119
- text: "This section is used to customize the 'intermediate screen', which is shown on the apps website while no app is active.",
127
+ text: "UI__NODE_EDITOR__INIT_APP_SESSION__INTERMEDIATE_SCREEN_DESCRIPTION__TEXT",
120
128
  },
121
129
  },
122
130
  {
123
131
  type: "select",
124
132
  key: "intermediateScreenCustomizationType",
125
- label: "Customization Type",
133
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__INTERMEDIATE_SCREEN_CUSTOMIZATION_TYPE__LABEL",
126
134
  params: {
127
135
  options: [
128
136
  {
129
- label: "No customization",
137
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__INTERMEDIATE_SCREEN_CUSTOMIZATION_TYPE__NONE__LABEL",
130
138
  value: "none",
131
139
  },
132
140
  {
133
- label: "Customized Texts",
141
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__INTERMEDIATE_SCREEN_CUSTOMIZATION_TYPE__OVERRIDE__LABEL",
134
142
  value: "override",
135
143
  },
136
144
  {
137
- label: "Replace with xApp",
145
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__INTERMEDIATE_SCREEN_CUSTOMIZATION_TYPE__APP__LABEL",
138
146
  value: "app",
139
147
  },
140
148
  ],
@@ -145,20 +153,23 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
145
153
  {
146
154
  type: "cognigyText",
147
155
  key: "intermediateScreenOverrideText",
148
- label: "Text Override",
149
- description: "Customizes the text that is shown on the 'intermediate' screen",
156
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__INTERMEDIATE_SCREEN_OVERRIDE_TEXT__LABEL",
157
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__INTERMEDIATE_SCREEN_OVERRIDE_TEXT__DESCRIPTION",
150
158
  defaultValue: "Nothing to do...",
151
159
  condition: {
152
160
  key: "intermediateScreenCustomizationType",
153
161
  value: "override",
154
162
  },
163
+ params: {
164
+ maxLength: 256,
165
+ },
155
166
  },
156
167
  // Intermediate Screen - Custom App
157
168
  {
158
169
  type: "cognigyText",
159
170
  key: "intermediateScreenAppTemplateId",
160
- label: "xApp Template",
161
- description: "Select which xApp Template should be used to replace the intermediate screen",
171
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__INTERMEDIATE_SCREEN_APP_TEMPLATE_ID__LABEL",
172
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__INTERMEDIATE_SCREEN_APP_TEMPLATE_ID__DESCRIPTION",
162
173
  defaultValue: "",
163
174
  condition: {
164
175
  key: "intermediateScreenCustomizationType",
@@ -171,8 +182,8 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
171
182
  {
172
183
  type: "json",
173
184
  key: "intermediateScreenAppTemplateData",
174
- label: "xApp Template Data",
175
- description: "Select which data should be provided to the xApp Template which replaces the intermediate screen",
185
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__INTERMEDIATE_SCREEN_APP_TEMPLATE_DATA__LABEL",
186
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__INTERMEDIATE_SCREEN_APP_TEMPLATE_DATA__DESCRIPTION",
176
187
  defaultValue: "{}",
177
188
  condition: {
178
189
  key: "intermediateScreenCustomizationType",
@@ -185,25 +196,25 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
185
196
  key: "connectionScreenDescription",
186
197
  label: " ",
187
198
  params: {
188
- text: "This section is used to customize the 'connection screen', which is shown on the apps website while the realtime connection to the backend is (re)-established.",
199
+ text: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_DESCRIPTION__TEXT",
189
200
  },
190
201
  },
191
202
  {
192
203
  type: "select",
193
204
  key: "connectionScreenCustomizationType",
194
- label: "Customization Type",
205
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_CUSTOMIZATION_TYPE__LABEL",
195
206
  params: {
196
207
  options: [
197
208
  {
198
- label: "No customization",
209
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_CUSTOMIZATION_TYPE__NONE__LABEL",
199
210
  value: "none",
200
211
  },
201
212
  {
202
- label: "Customized Texts",
213
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_CUSTOMIZATION_TYPE__OVERRIDE__LABEL",
203
214
  value: "override",
204
215
  },
205
216
  {
206
- label: "Replace with xApp",
217
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_CUSTOMIZATION_TYPE__APP__LABEL",
207
218
  value: "app",
208
219
  },
209
220
  ],
@@ -214,42 +225,51 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
214
225
  {
215
226
  type: "cognigyText",
216
227
  key: "connectionScreenOverrideConnectingText",
217
- label: "Connecting Text Override",
218
- description: "This text is shown while a connection to the backend is being established.",
228
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_OVERRIDE_CONNECTING_TEXT__LABEL",
229
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_OVERRIDE_CONNECTING_TEXT__DESCRIPTION",
219
230
  defaultValue: "Connecting...",
220
231
  condition: {
221
232
  key: "connectionScreenCustomizationType",
222
233
  value: "override",
223
234
  },
235
+ params: {
236
+ maxLength: 256,
237
+ },
224
238
  },
225
239
  {
226
240
  type: "cognigyText",
227
241
  key: "connectionScreenOverrideInvalidText",
228
- label: "'Invalid' Error Message",
229
- description: "This Error message is shown if the token is invalid (e.g. the link was opened after the session expired).",
242
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_OVERRIDE_INVALID_TEXT__LABEL",
243
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_OVERRIDE_INVALID_TEXT__DESCRIPTION",
230
244
  defaultValue: "This session does not exist or is no longer active.",
231
245
  condition: {
232
246
  key: "connectionScreenCustomizationType",
233
247
  value: "override",
234
248
  },
249
+ params: {
250
+ maxLength: 256,
251
+ },
235
252
  },
236
253
  {
237
254
  type: "cognigyText",
238
255
  key: "connectionScreenOverrideUnavailableText",
239
- label: "'Unavailable' Error Message",
240
- description: "This Error message is shown when the backend turns out to be unreachable.",
256
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_OVERRIDE_UNAVAILABLE_TEXT__LABEL",
257
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_OVERRIDE_UNAVAILABLE_TEXT__DESCRIPTION",
241
258
  defaultValue: "The application is not available right now.",
242
259
  condition: {
243
260
  key: "connectionScreenCustomizationType",
244
261
  value: "override",
245
262
  },
263
+ params: {
264
+ maxLength: 256,
265
+ },
246
266
  },
247
267
  // Connection Screen - Custom App
248
268
  {
249
269
  type: "cognigyText",
250
270
  key: "connectionScreenAppTemplateId",
251
- label: "xApp Template",
252
- description: "Select which xApp Template should be used to replace the connection screen",
271
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_APP_TEMPLATE_ID__LABEL",
272
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_APP_TEMPLATE_ID__DESCRIPTION",
253
273
  defaultValue: "",
254
274
  condition: {
255
275
  key: "connectionScreenCustomizationType",
@@ -262,8 +282,8 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
262
282
  {
263
283
  type: "json",
264
284
  key: "connectionScreenAppTemplateData",
265
- label: "xApp Template Data",
266
- description: "Select which data should be provided to the xApp Template which replaces the connection screen",
285
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_APP_TEMPLATE_DATA__LABEL",
286
+ description: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_APP_TEMPLATE_DATA__DESCRIPTION",
267
287
  defaultValue: "{}",
268
288
  condition: {
269
289
  key: "connectionScreenCustomizationType",
@@ -273,7 +293,7 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
273
293
  ],
274
294
  sections: [
275
295
  {
276
- label: "Style Customization",
296
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__STYLE_SECTION__LABEL",
277
297
  key: "styleSection",
278
298
  fields: [
279
299
  "backgroundColor",
@@ -281,23 +301,19 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
281
301
  "errorTextColor",
282
302
  "logo",
283
303
  "logoUrl",
304
+ "faviconUrl",
305
+ "pageTitle",
284
306
  ],
285
307
  defaultCollapsed: false,
286
308
  },
287
309
  {
288
- label: "PIN Screen",
289
- key: "pinScreenSection",
290
- fields: ["pinEnterPinText", "pinIncorrectText", "pinUnavailableText"],
291
- defaultCollapsed: false,
292
- },
293
- {
294
- label: "xApp Screens",
310
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__APP_SCREENS_SECTION__LABEL",
295
311
  key: "appScreensSection",
296
312
  fields: ["appLoadingText", "appLaunchErrorText", "appErrorText"],
297
313
  defaultCollapsed: false,
298
314
  },
299
315
  {
300
- label: "Intermediate Screen",
316
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__INTERMEDIATE_SCREEN_SECTION__LABEL",
301
317
  key: "intermediateScreenSection",
302
318
  fields: [
303
319
  "intermediateScreenDescription",
@@ -309,7 +325,7 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
309
325
  defaultCollapsed: false,
310
326
  },
311
327
  {
312
- label: "Connection Screen",
328
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__CONNECTION_SCREEN_SECTION__LABEL",
313
329
  key: "connectionScreenSection",
314
330
  fields: [
315
331
  "connectionScreenDescription",
@@ -328,10 +344,6 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
328
344
  type: "section",
329
345
  key: "styleSection",
330
346
  },
331
- {
332
- type: "section",
333
- key: "pinScreenSection",
334
- },
335
347
  {
336
348
  type: "section",
337
349
  key: "appScreensSection",
@@ -345,12 +357,12 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
345
357
  key: "connectionScreenSection",
346
358
  },
347
359
  ],
348
- tags: ["basic", "apps"],
360
+ tags: ["basic", "apps", "xApps"],
349
361
  tokens: [
350
362
  {
351
363
  type: "input",
352
- label: "xApp Session URL",
353
- script: "input.apps.url || ''"
364
+ label: "UI__NODE_EDITOR__INIT_APP_SESSION__TOKEN_XAPP_SESSION_URL__LABEL",
365
+ script: "input.apps.url || ''",
354
366
  },
355
367
  ],
356
368
  function: async ({ cognigy, config }) => {
@@ -358,9 +370,7 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
358
370
  const { api, input } = cognigy;
359
371
  const {
360
372
  // styling
361
- backgroundColor, textColor, errorTextColor, logo, logoUrl,
362
- // pin screen
363
- pinEnterPinText, pinIncorrectText, pinUnavailableText,
373
+ backgroundColor, textColor, errorTextColor, logo, logoUrl, faviconUrl, pageTitle,
364
374
  // apps screen
365
375
  appLoadingText, appLaunchErrorText, appErrorText,
366
376
  // intermediate screen
@@ -378,6 +388,12 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
378
388
  if (errorTextColor !== "" && errorTextColor !== undefined) {
379
389
  ret.errorTextColor = errorTextColor;
380
390
  }
391
+ if (faviconUrl) {
392
+ ret.faviconUrl = faviconUrl;
393
+ }
394
+ if (pageTitle) {
395
+ ret.pageTitle = pageTitle;
396
+ }
381
397
  switch (logo) {
382
398
  case "none":
383
399
  ret.logoUrl = null;
@@ -393,11 +409,6 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
393
409
  }
394
410
  return ret;
395
411
  })();
396
- const pinScreenCustomization = {
397
- enterPinText: pinEnterPinText,
398
- incorrectText: pinIncorrectText,
399
- unavailableText: pinUnavailableText,
400
- };
401
412
  const appScreenCustomization = {
402
413
  loadingText: appLoadingText,
403
414
  launchErrorText: appLaunchErrorText,
@@ -455,15 +466,16 @@ exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
455
466
  style: style,
456
467
  intermediateScreen: intermediateScreenCustomization,
457
468
  statusScreen: statusScreenCustomization,
458
- pinScreen: pinScreenCustomization,
459
469
  appScreen: appScreenCustomization,
460
470
  };
461
471
  })();
462
472
  if (!input.apps.session.token) {
463
- const appSessionToken = await api.initAppSession();
473
+ const appSessionToken = await api.initAppSession({
474
+ styleConfig: customization,
475
+ });
464
476
  api.addToInput("apps.session.token", appSessionToken);
465
477
  }
466
- const finalUrl = (0, buildAppUrl_1.buildAppUrl)(input.apps.baseUrl, (_a = input.apps.session) === null || _a === void 0 ? void 0 : _a.token, customization);
478
+ const finalUrl = (0, buildAppUrl_1.buildAppUrl)(input.apps.baseUrl, (_a = input.apps.session) === null || _a === void 0 ? void 0 : _a.token);
467
479
  api.addToInput("apps.url", finalUrl);
468
480
  api.addToInput("apps.customization", customization || null);
469
481
  },
@@ -1,8 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SET_ADAPTIVE_CARD_APP_STATE = void 0;
3
+ exports.setxAppResult = exports.SET_ADAPTIVE_CARD_APP_STATE = void 0;
4
4
  /* Custom modules */
5
5
  const createNodeDescriptor_1 = require("../../createNodeDescriptor");
6
+ const BaseContext_1 = require("../../../helper/BaseContext");
6
7
  /**
7
8
  * Node name: 'setAdaptiveCardAppState'
8
9
  *
@@ -11,8 +12,8 @@ const createNodeDescriptor_1 = require("../../createNodeDescriptor");
11
12
  */
12
13
  exports.SET_ADAPTIVE_CARD_APP_STATE = (0, createNodeDescriptor_1.createNodeDescriptor)({
13
14
  type: "setAdaptiveCardAppState",
14
- defaultLabel: "Set AdaptiveCard xApp State",
15
- summary: "Shows an AdaptiveCard via an xApp",
15
+ defaultLabel: "xApp: Show Adaptive Card",
16
+ summary: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_APP_STATE__SUMMARY",
16
17
  appearance: {
17
18
  showIcon: false,
18
19
  },
@@ -20,47 +21,128 @@ exports.SET_ADAPTIVE_CARD_APP_STATE = (0, createNodeDescriptor_1.createNodeDescr
20
21
  {
21
22
  key: "card",
22
23
  type: "json",
23
- label: "AdaptiveCard Definition",
24
- description: "Insert a definition for an AdaptiveCard here. See https://adaptivecards.io/designer for help",
24
+ label: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_APP_STATE__CARD__LABEL",
25
+ description: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_APP_STATE__CARD__DESCRIPTION",
25
26
  defaultValue: {},
26
27
  },
27
28
  {
28
29
  key: "primaryColor",
29
30
  type: "cognigyText",
30
- label: "Primary Color Override",
31
- description: "Alters the color of the background and interaction elements. Has to be a CSS-compatible color",
31
+ label: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_APP_STATE__PRIMARY_COLOR__LABEL",
32
+ description: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_APP_STATE__PRIMARY_COLOR__DESCRIPTION",
32
33
  defaultValue: "",
33
34
  },
34
35
  {
35
36
  key: "primaryContrastColor",
36
37
  type: "cognigyText",
37
- label: "Primary Contrast Color Override",
38
- description: "Alters the color of text that is rendered on the 'Primary Color' (e.g. button labels). Has to be a CSS-compatible color",
38
+ label: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_APP_STATE__PRIMARY_CONTRAST_COLOR__LABEL",
39
+ description: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_APP_STATE__PRIMARY_CONTRAST_COLOR__DESCRIPTION",
39
40
  defaultValue: "",
40
41
  },
42
+ {
43
+ key: "waitForInput",
44
+ type: "toggle",
45
+ label: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_APP_STATE__WAIT_FOR_INPUT__LABEL",
46
+ defaultValue: false,
47
+ },
48
+ {
49
+ key: "storeResultInContext",
50
+ type: "toggle",
51
+ label: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_APP_STATE__STORE_RESULT_IN_CONTEXT__LABEL",
52
+ condition: {
53
+ key: "waitForInput",
54
+ value: true
55
+ }
56
+ },
57
+ {
58
+ key: "contextKey",
59
+ type: "cognigyText",
60
+ label: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_APP_STATE__CONTEXT_KEY__LABEL",
61
+ defaultValue: "result",
62
+ condition: {
63
+ and: [
64
+ {
65
+ key: "waitForInput",
66
+ value: true
67
+ }, {
68
+ key: "storeResultInContext",
69
+ value: true
70
+ }
71
+ ]
72
+ },
73
+ },
41
74
  ],
42
75
  sections: [
43
76
  {
44
77
  key: "overrideSection",
45
78
  defaultCollapsed: true,
46
79
  fields: ["primaryColor", "primaryContrastColor"],
47
- label: "Style Overrides",
80
+ label: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_APP_STATE__OVERRIDE_SECTIONS__LABEL",
48
81
  },
82
+ {
83
+ key: "waitingBehavior",
84
+ defaultCollapsed: true,
85
+ fields: ["waitForInput", "storeResultInContext", "contextKey"],
86
+ label: "UI__NODE_EDITOR__SET_ADAPTIVE_CARD_APP_STATE__WAITING_BEHAVIOR__LABEL",
87
+ }
49
88
  ],
50
89
  form: [
51
90
  { type: "field", key: "card" },
52
91
  { type: "section", key: "overrideSection" },
92
+ { type: "section", key: "waitingBehavior" },
53
93
  ],
54
- tags: ["basic", "apps"],
55
- function: async ({ cognigy, config }) => {
56
- const { api, input } = cognigy;
57
- const { card, primaryColor, primaryContrastColor, } = config;
94
+ tags: ["basic", "apps", "xApps"],
95
+ function: async ({ cognigy, config, nodeId }) => {
96
+ var _a, _b;
97
+ const { api, input, context } = cognigy;
98
+ const { card, primaryColor, primaryContrastColor, waitForInput, storeResultInContext, contextKey, } = config;
99
+ const systemContextWaitingKey = `adaptiveCardAPPWaiting-${nodeId}`;
58
100
  const appTemplateURL = `${input.apps.baseUrl}/apps/adaptivecards/`;
59
- api.setAppState(appTemplateURL, {
60
- card,
61
- primaryColor: primaryColor || undefined,
62
- primaryContrastColor: primaryContrastColor || undefined,
63
- });
101
+ // only set the app state once
102
+ if (!api.getSystemContext(systemContextWaitingKey)) {
103
+ api.setAppState(appTemplateURL, {
104
+ card,
105
+ primaryColor: primaryColor || undefined,
106
+ primaryContrastColor: primaryContrastColor || undefined,
107
+ });
108
+ }
109
+ if (api.getSystemContext(systemContextWaitingKey) && contextKey && ((_b = (_a = input.data) === null || _a === void 0 ? void 0 : _a._cognigy) === null || _b === void 0 ? void 0 : _b._app)) {
110
+ api.deleteSystemContext(systemContextWaitingKey);
111
+ (0, exports.setxAppResult)({
112
+ input,
113
+ storeResultInContext,
114
+ contextKey,
115
+ context,
116
+ });
117
+ return;
118
+ }
119
+ if (waitForInput) {
120
+ api.setSystemContext(systemContextWaitingKey, true);
121
+ api.setNextNode(nodeId);
122
+ api.stopExecution();
123
+ }
64
124
  },
65
125
  });
126
+ /**
127
+ * Sets the result of an xApp in the context
128
+ */
129
+ const setxAppResult = (params) => {
130
+ var _a, _b, _c;
131
+ const { input, storeResultInContext, contextKey, context } = params;
132
+ const result = (_c = (_b = (_a = input === null || input === void 0 ? void 0 : input.data) === null || _a === void 0 ? void 0 : _a._cognigy) === null || _b === void 0 ? void 0 : _b._app) === null || _c === void 0 ? void 0 : _c.payload;
133
+ if (storeResultInContext) {
134
+ // check whether contextKey or inputKey is a deep query and set
135
+ // storage location accordingly
136
+ let location = context;
137
+ let target = contextKey;
138
+ // deep query
139
+ if (target.indexOf(".") > -1) {
140
+ const splits = target.split(".");
141
+ location = BaseContext_1.BaseContext.findLocationPathStateless(splits, true, location);
142
+ target = splits[splits.length - 1];
143
+ }
144
+ location[target] = result;
145
+ }
146
+ };
147
+ exports.setxAppResult = setxAppResult;
66
148
  //# sourceMappingURL=setAdaptiveCardAppState.js.map