kore-web-sdk 10.1.0 → 10.1.1

package/README.md

@@ -0,0 +1,153 @@
+# Kore.ai SDK
+Kore.ai offers Bots SDKs as a set of platform-specific client libraries that provide a quick and convenient way to integrate Kore.ai Bots chat capability into custom applications.
+
+With just few lines of code, you can embed our Kore.ai chat widget into your applications to enable end-users to interact with your applications using Natural Language. For more information, refer to
+
+[Bot SDKs](https://developer.kore.ai/docs/bots/kore-web-sdk/)
+
+[Web Socket Endpoints and Events](https://developer.kore.ai/docs/bots/sdks/bots-platform-api-reference/)
+
+[SDK Security](https://developer.kore.ai/docs/bots/sdks/user-authorization-and-assertion/)
+
+[SDK App Registration](https://developer.kore.ai/docs/bots/sdks/sdk-app-registration/)
+
+[Message Templates](https://developer.kore.ai/docs/bots/sdks/message-templates/)
+
+[API Referernce](https://rajasekharba-kore.github.io/web-kore-sdk/)
+
+[FAQ's](/docs/faqs) 
+
+
+## 💡 Getting Started
+
+First, install kore web SDK via the [npm](https://www.npmjs.com/get-npm) package manager:
+
+```bash
+npm install --save kore-web-sdk
+```
+
+Get chatWindow and chatConfig
+
+```js
+import { chatConfig, chatWindow } from 'kore-web-sdk';
+
+```
+Configure ChatConfig
+
+
+
+```js
+
+let botOptions=chatConfig.botOptions;
+	
+ botOptions.JWTUrl = "PLEASE_ENTER_JWTURL_HERE";
+ botOptions.userIdentity = 'PLEASE_ENTER_USER_EMAIL_ID';// Provide users email id here
+ botOptions.botInfo = { name: "PLEASE_ENTER_BOT_NAME", "_id": "PLEASE_ENTER_BOT_ID" }; // bot name is case sensitive
+ botOptions.clientId = "PLEASE_ENTER_CLIENT_ID";
+ botOptions.clientSecret = "PLEASE_ENTER_CLIENT_SECRET";
+ /* 
+ Important Note: These keys are provided here for quick demos to generate JWT token at client side but not for Production environment.
+ Refer below document for JWT token generation at server side. Client Id and Client secret should maintained at server end.
+ https://developer.kore.ai/docs/bots/sdks/user-authorization-and-assertion/
+ **/
+
+```
+
+
+Create chat window instance and trigger show method
+```js
+var chatWindowInstance = new chatWindow(chatConfig);
+chatWindowInstance.show(chatConfig);
+
+```
+### Examples
+Click [here](/docs/sdkdeveloper) to explore different variations how SDK can be consumed 
+
+### Other options
+<details>
+ <summary>Legacy</summary>
+
+include the following script in your html file and configure bot configurations 
+
+```js
+
+<script  src="https://cdn.jsdelivr.net/npm/kore-web-sdk@10.1.1/dist/umd/kore-web-sdk-umd-chat.min.js"></script>
+<script>
+        //chat window declaration
+        var chatConfig=KoreChatSDK.chatConfig;
+        var chatWindow=KoreChatSDK.chatWindow;
+        
+        //create chat window instance
+        var chatWindowInstance = new chatWindow();
+
+        //configure bot configurations
+        var botOptions=chatConfig.botOptions;
+        botOptions.JWTUrl = "PLEASE_ENTER_JWTURL_HERE";
+        botOptions.userIdentity = 'PLEASE_ENTER_USER_EMAIL_ID';
+        botOptions.botInfo = { name: "PLEASE_ENTER_BOT_NAME", "_id": "PLEASE_ENTER_BOT_ID" }; // bot name is case sensitive
+        botOptions.clientId = "PLEASE_ENTER_CLIENT_ID";
+        botOptions.clientSecret = "PLEASE_ENTER_CLIENT_SECRET";
+	/* 
+	Important Note: These keys are provided here for quick demos to generate JWT token at client side but not for Production environment.
+	Refer below document for JWT token generation at server side. Client Id and Client secret should maintained at server end.
+	https://developer.kore.ai/docs/bots/sdks/user-authorization-and-assertion/
+	**/
+
+        //show chatwindow
+        chatWindowInstance.show(chatConfig);
+
+</script>
+
+```
+	
+</details>
+
+
+<details>
+ <summary>For quick demo</summary>
+ 
+ 
+
+####  Instructions
+	1.Open examples/umd/chat-with-plugins/index.html  
+	2.configure bot configurations   
+	3.Open same file in any browser 
+	
+
+ 
+
+</details>
+
+## 💡 Custom Templates
+
+In addition to the kore message templates, new custom templates can be intstalled into kore chat window with *installTemplate* method
+
+```bash
+class customTemplateComponent{
+  renderMessage(msgData){
+      if(msgData?.message[0]?.component?.payload?.template_type==='custom_stock_template'){
+          return '<h2>My Template HTML</h2>';      
+      }else{
+          return false;
+      }
+  } 
+}
+
+chatWindowInstance.templateManager.installTemplate(new customTemplateComponent());
+```
+Other framework UI components like angular and react can also be injected with this
+
+## 💡 Plugins
+
+Kore's chatwindow functionlity can be extended with the help of plugins.Newly created plugins can be installed with *installPlugin* method
+
+```bash
+class KoreCustomPlugin{
+  
+}
+
+chatWindowInstance.installPlugin(new KoreCustomPlugin());
+```
+Kore offered plugins are listed [here](./docs/plugins)
+
+

package/dist/components/chatwindow/chatWindow.d.ts

@@ -190,6 +190,7 @@ declare class chatWindow extends EventEmitter {
         renderType: string;
         fromHistorySync: any;
     } | any): false | undefined;
+    prepareAriaTagsOnMessage(msgData: any, messageHtml: any): void;
     generateMessageDOM(msgData?: any): any;
     pushTorenderMessagesQueue(msgItem: any): void;
     startRenderEventLoop(): void;
@@ -198,6 +199,7 @@ declare class chatWindow extends EventEmitter {
     openExternalLink(link_url: any): void;
     getChatTemplate(tempType: string): string;
     historyLoadingComplete(): void;
+    historySyncing(msgData: any, res: any, index: any): void;
     chatHistory(res: {
         messages: string | any[];
     }[] | any): false | undefined;

package/dist/esm/exports.d.ts

@@ -11,6 +11,8 @@ export{KorePickersPlugin}from"./plugins/kore-picker-plugin.js";
 // @ts-ignore
 export{GraphTemplatesPlugin}from"./plugins/kore-graph-templates-plugin.js";
 // @ts-ignore
+export {SolutionsTemplatesPlugin} from './plugins/kore-solutions-plugin.js'
+// @ts-ignore
 export{WebKitSTT}from"./plugins/webapi-stt-plugin.js";
 // @ts-ignore
 export{BrowserTTS}from"./plugins/browser-tts-plugin.js";

package/dist/esm/exports.js

@@ -1 +1 @@
-export{chatWindow}from"./kore-web-sdk-chat.min.js";export{chatConfig}from"./kore-web-sdk-chat.min.js";export{KoreWidgetSDK}from"./kore-web-sdk-widgets.js";export{widgetsConfig}from"./kore-web-sdk-widgets.js";export{KorePickersPlugin}from"./plugins/kore-picker-plugin.js";export{GraphTemplatesPlugin}from"./plugins/kore-graph-templates-plugin.js";export{WebKitSTT}from"./plugins/webapi-stt-plugin.js";export{BrowserTTS}from"./plugins/browser-tts-plugin.js";export{AgentDesktopPlugin}from"./plugins/agent-desktop.js";export{GoogleSTT}from"./plugins/google-stt-plugin.js";export{GoogleTTS}from"./plugins/google-tts-plugin.js";export{AzureSTT}from"./plugins/azure-stt-plugin.js";export{AzureTTS}from"./plugins/azure-tts-plugin.js";export{SpeakTextWithAWSPolly}from"./plugins/koreawspolly-st-plugin.js";export{KoreDesktopNotificationPlugin}from"./plugins/kore-desktop-notification.js";export{SearchSuggestionsPlugin}from"./plugins/search-suggestions.js";export{KoreFileUploaderPlugin}from"./plugins/file-upload.js";
+export{chatWindow}from"./kore-web-sdk-chat.min.js";export{chatConfig}from"./kore-web-sdk-chat.min.js";export{KoreWidgetSDK}from"./kore-web-sdk-widgets.js";export{widgetsConfig}from"./kore-web-sdk-widgets.js";export{KorePickersPlugin}from"./plugins/kore-picker-plugin.js";export{GraphTemplatesPlugin}from"./plugins/kore-graph-templates-plugin.js";export{WebKitSTT}from"./plugins/webapi-stt-plugin.js";export{BrowserTTS}from"./plugins/browser-tts-plugin.js";export{AgentDesktopPlugin}from"./plugins/agent-desktop.js";export{GoogleSTT}from"./plugins/google-stt-plugin.js";export{GoogleTTS}from"./plugins/google-tts-plugin.js";export{AzureSTT}from"./plugins/azure-stt-plugin.js";export{AzureTTS}from"./plugins/azure-tts-plugin.js";export{SpeakTextWithAWSPolly}from"./plugins/koreawspolly-st-plugin.js";export{KoreDesktopNotificationPlugin}from"./plugins/kore-desktop-notification.js";export{SearchSuggestionsPlugin}from"./plugins/search-suggestions.js";export{KoreFileUploaderPlugin}from"./plugins/file-upload.js";export{SolutionsTemplatesPlugin}from"./plugins/kore-solutions-plugin.js";