bibot 1.0.57 → 1.0.60

package/README.md

@@ -1,6 +1,7 @@
+
 # bibot
 
-> Made with create-react-library
+> CloudSec LLC BiBot plugin for easy integration into your application
 
 [![NPM](https://img.shields.io/npm/v/bibot.svg)](https://www.npmjs.com/package/bibot) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
@@ -10,7 +11,17 @@
 npm install --save bibot
 ```
 
-## Usage
+### `BiBot` Component Props
+
+- **`clientId`** (string): **Required**. Your client ID for using the BiBot services.
+- **`client_session_id`** (string): Optional. An optional session ID for tracking client sessions. This is provided if you do not provide.
+- **`redirect_notice`** (boolean): Optional. If set to `true`, the bot will handle redirect notices to 3rd party integration if you have any such as slack.
+- **`test`** (boolean): Optional. If set to `true`, the bot will use the test endpoint for making requests. Useful for initial testing.
+- **`internalUserOnly`** (object): **Required**. Contains information for internal user access.
+  - **`internalUseOnly`** (boolean): **Required**. Indicates if the bot is for internal use only.
+  - **`jwt`** (string): **Required if `internalUseOnly` is `true`**. The JSON Web Token for authorizing internal users. This must include sub, username, given_name and family_name.
+
+### Example with All Props
 
 ```tsx
 import { BiBot } from 'bibot'
@@ -18,7 +29,13 @@ import { BiBot } from 'bibot'
 function App() {
   return (
     <div className="App">
-      <BiBot clientId='YOUR CLIENT ID HERE' />
+      <BiBot 
+        clientId='YOUR CLIENT ID HERE'
+        client_session_id='YOUR SESSION ID HERE'
+        redirect_notice={true}
+        test={false}
+        internalUserOnly={{ internalUseOnly: true, jwt: 'YOUR JWT HERE' }}
+      />
     </div>
   );
 }
@@ -26,6 +43,63 @@ function App() {
 export default App;
 ```
 
+### Error Handling
+
+If `internalUseOnly` is set to `true` but `jwt` is not provided, the component will throw an error:
+```
+Error: Internal use only requires jwt. Please refer to documentation on https://www.npmjs.com/package/bibot
+```
+
+## Reporting Bugs
+
+If you encounter any bugs or issues, please follow these steps to report them:
+
+1. **Search for existing issues**: Before creating a new issue, please check the [Issues](https://github.com/chrisdjin/bibot_plugin/issues) page to see if the problem has already been reported.
+
+2. **Create a new issue**: If your issue hasn't been reported yet, create a new issue with the following details:
+   - A clear and descriptive title.
+   - A detailed description of the problem, including steps to reproduce it.
+   - Any relevant screenshots or code snippets.
+   - Information about your environment (e.g., operating system, browser, Node.js version).
+
+3. **Provide additional context**: If possible, provide additional context that might help us understand the issue, such as error messages or logs.
+
+
+
+## Contributing
+
+We welcome contributions from the community! To contribute, please follow these steps:
+
+1. **Fork the repository**: Fork the [bibot repository](https://github.com/chrisdjin/bibot_plugin.git) to your GitHub account.
+
+2. **Clone the repository**: Clone the forked repository to your local machine.
+   ```bash
+   git clone https://github.com/chrisdjin/bibot_plugin.git
+   ```
+
+3. **Create a new branch**: Create a new branch for your feature or bug fix.
+   ```bash
+   git checkout -b feature-or-bugfix-name
+   ```
+
+4. **Make your changes**: Make your changes to the codebase.
+
+5. **Commit your changes**: Commit your changes with a clear and descriptive commit message.
+   ```bash
+   git commit -m "Description of the feature or bug fix"
+   ```
+
+6. **Push your changes**: Push your changes to your forked repository.
+   ```bash
+   git push origin feature-or-bugfix-name
+   ```
+
+7. **Create a pull request**: Go to the original repository and create a pull request with a clear and detailed description of your changes.
+
+8. **Review process**: Your pull request will be reviewed by the maintainers. Please address any feedback or changes requested during the review process.
+
+Thank you for your contributions!
+
 ## License
 
 ISC © [chrisdjin](https://github.com/chrisdjin)

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 import * as React from 'react';
 import './styles.css';
 import { BiBotProps } from './types/coreInterfaces';
-export declare const BiBot: (bibotProps: BiBotProps) => React.JSX.Element;
+export declare const BiBot: React.FC<BiBotProps>;

package/dist/index.js

@@ -3727,10 +3727,13 @@ var useBiBotChatBot = function useBiBotChatBot(bibotProps) {
   var _useContext = React.useContext(AppContext),
     state = _useContext.state,
     dispatch = _useContext.dispatch;
-  var baseURL = bibotProps !== null && bibotProps !== void 0 && bibotProps.test ? endpoints.getInferenceURL(bibotProps === null || bibotProps === void 0 ? void 0 : bibotProps.test) : endpoints.getInferenceURL(false);
-  var pluginAxiosInstance = createPluginAxiosInstance(baseURL, {}, {
-    Authorization: bibotProps.jwt
-  });
+  var baseURL = endpoints.getInferenceURL(!!(bibotProps !== null && bibotProps !== void 0 && bibotProps.test));
+  if (bibotProps.internalUserOnly.internalUseOnly && !bibotProps.internalUserOnly.jwt) {
+    throw new Error('Internal use only requires jwt. Please refer to documentation on https://www.npmjs.com/package/bibot');
+  }
+  var pluginAxiosInstance = bibotProps.internalUserOnly.internalUseOnly ? createPluginAxiosInstance(baseURL, {}, {
+    Authorization: bibotProps.internalUserOnly.jwt
+  }) : createPluginAxiosInstance(baseURL, {}, {});
   var _useState = React.useState(true),
     showPredefinedQuestions = _useState[0],
     setShowPredefinedQuestions = _useState[1];
@@ -4461,13 +4464,33 @@ var ChatBubbleBiBot = function ChatBubbleBiBot(bibotProps) {
 };
 
 var BiBot = function BiBot(bibotProps) {
-  return React.createElement(AppProvider, null, React.createElement(ChatBubbleBiBot, {
-    jwt: bibotProps.jwt,
-    clientId: bibotProps.clientId,
-    client_session_id: bibotProps.client_session_id,
-    redirect_notice: bibotProps.redirect_notice,
-    test: bibotProps.test
-  }));
+  var clientId = bibotProps.clientId,
+    client_session_id = bibotProps.client_session_id,
+    redirect_notice = bibotProps.redirect_notice,
+    test = bibotProps.test,
+    internalUserOnly = bibotProps.internalUserOnly;
+  if (internalUserOnly.internalUseOnly) {
+    return React.createElement(AppProvider, null, React.createElement(ChatBubbleBiBot, {
+      clientId: clientId,
+      client_session_id: client_session_id,
+      redirect_notice: redirect_notice,
+      test: test,
+      internalUserOnly: {
+        internalUseOnly: true,
+        jwt: internalUserOnly.jwt
+      }
+    }));
+  } else {
+    return React.createElement(AppProvider, null, React.createElement(ChatBubbleBiBot, {
+      clientId: clientId,
+      client_session_id: client_session_id,
+      redirect_notice: redirect_notice,
+      test: test,
+      internalUserOnly: {
+        internalUseOnly: false
+      }
+    }));
+  }
 };
 
 exports.BiBot = BiBot;