kore-web-sdk 10.20.0 → 10.20.1

package/README.md

@@ -1,156 +1,156 @@
-# 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://koredotcom.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@legacy-v2
-```
-
-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.20.0/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 data-kr-msg-id=' + msgData.messageId + ' data-time=' + msgData.createdOnTimemillis + '>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
-> [!NOTE]
-> - Please add the following two attributes for parent div in the custom template html
-> - `data-kr-msg-id` with value `msgData.messageId` and `data-time` with value `msgData.createdOnTimemillis`
-
-## 💡 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)
-
-
+# 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://koredotcom.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@legacy-v2
+```
+
+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.20.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 data-kr-msg-id=' + msgData.messageId + ' data-time=' + msgData.createdOnTimemillis + '>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
+> [!NOTE]
+> - Please add the following two attributes for parent div in the custom template html
+> - `data-kr-msg-id` with value `msgData.messageId` and `data-time` with value `msgData.createdOnTimemillis`
+
+## 💡 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/base-sdk/kore-bot-sdk-client.d.ts

@@ -1,2 +1,2 @@
-export default requireKr;
-declare function requireKr(o: any, u: any): any;
+export default requireKr;
+declare function requireKr(o: any, u: any): any;