cbstate and chat, add explaination and example

Nursid · Nursid · commit ef1f3e3c2146 · 2024-06-04T14:40:00.000+05:30
diff --git a/docs/api/browser/click.md b/docs/api/browser/click.md
@@ -21,9 +21,9 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
- ### Examples
+### Examples
 
- ```js
+```js
 // Using Codebolt's browser API, you can interact with elements on a web page.
 // For example, let's say there's a button with the ID "test" on the page.
 // You can use Codebolt's browser API to click on this button.
@@ -42,12 +42,11 @@ data:
 // Putting it all together:
 codebolt.browser.click("#test");
 
- ```
+```
 
- ### Explaination 
+### Explaination 
 
 [Browser](../../concepts/browser)  Click function is used to click on the browser by selecting specific elementId.
 
-A browser is a used to access and display web pages on the internet. When a browser is open, users can interact with various elements on web pages, such as buttons, links, forms, and images.
+A browser is a used to access and display web pages. When a browser is open, users can interact with various elements on web pages, such as buttons, links, forms, and images.
 
-One common action in web development and automation is clicking on specific elements within a web page. This action is typically performed by selecting the element using its unique identifier, often referred to as the element ID, and then triggering a click event on that element.
diff --git a/docs/api/browser/close.md b/docs/api/browser/close.md
@@ -30,11 +30,8 @@ data:
  ```
 ### Explaination
 
-Navigation: The script first opens a browser window/tab and navigates to the specified URL using codebolt.browser.goToPage(url). In this example, it navigates to "https://example.com".
-
-Testing: Once on the web page, the script performs various tests to validate the functionality of the application.
-
-Closing the Page: After completing the tests on the current page, the codebolt.browser.close() function is used to close the current page/tab. This action is useful for cleaning up after testing is complete and for ensuring that the browser environment is left in a desired state.
+The script first opens a browser window/tab and navigates to the specified URL using codebolt.browser.goToPage(url). In this example, it navigates to "https://example.com".
 
+After completing the task on the current page, the codebolt.browser.close() function is used to close the current page.
 
  
diff --git a/docs/api/browser/enter.md b/docs/api/browser/enter.md
@@ -38,8 +38,4 @@ await codebolt.browser.enter();
 
 ### Explanation:
 
-Navigation: The script navigates to the sign-in page of the website.
-
-Entering Data: Using codebolt.browser.type(), the script fills in the username and password fields with the appropriate credentials.
-
-Simulating Enter Key Press: Instead of clicking a submit button, the script uses codebolt.browser.enter() to simulate pressing the Enter key. This action triggers the default submission behavior of the form, submitting the entered username and password for authentication.
+The codebolt.browser.enter() function is used to submit the form. Suppose there is a login form and I want to automatically submit it using a script. Then, we want to send text to a username field on the login page using the type() function, which has two parameters: eventid and "value". After inputting all the information, we call enter() to submit the form.
diff --git a/docs/api/browser/extractText.md b/docs/api/browser/extractText.md
@@ -32,8 +32,5 @@ console.log(pageText);
 
 ### Explaination: 
 
-Navigation: The script starts by navigating to the news website's homepage using codebolt.browser.goToPage("https://example-news.com").
+If we want to extract all the text on the webpage, we can use the codebolt.browser.extractText() function. This function returns the text, which we can store in a variable and use.
 
-Text Extraction: Once the page has loaded, the script uses codebolt.browser.extractText() to extract all the text content from the current page. This function captures all textual information present on the web page, including headings, paragraphs, and any other text elements.
-
-Processing the Extracted Text: The extracted text is stored in the variable pageText. In this example, the script simply logs the extracted text to the console using console.log(pageText). In a real-world scenario, you might further process this text to analyze news headlines, summarize content, or extract specific information.
diff --git a/docs/api/browser/getContent.md b/docs/api/browser/getContent.md
@@ -16,28 +16,7 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Examples: 
 
-```js
+### Status 
+Working Progress...
 
-// Navigate to the blog page
-await codebolt.browser.goToPage("https://example-blog.com/article")
-
-// Retrieve the HTML content of the current page
-const pageContent = await codebolt.browser.getContent()
-
-// Log the retrieved content to the console (or save it as needed)
-console.log(pageContent)
-
-```
-
-### Explanation:
-The codebolt.browser.getContent() function is used to retrieve the entire HTML content of the current web page. This function is particularly useful in web scraping, data extraction, and automated testing scenarios where you need to capture the full structure and content of a web page for further processing or analysis.
-
-### Explaination of the code: 
-
-Navigation: The script begins by navigating to the specific blog page using codebolt.browser.goToPage("https://example-blog.com/article").
-
-Content Retrieval: Once the page has fully loaded, the script uses codebolt.browser.getContent() to retrieve the complete HTML content of the current page. This includes all HTML tags, embedded styles, scripts, and textual content.
-
-Processing the Retrieved Content: The retrieved HTML content is stored in the variable pageContent. In this example, the script logs the HTML content to the console using console.log(pageContent). In a real-world scenario, you might save this content to a file or a database for later analysis or offline access.
diff --git a/docs/api/browser/getHTML.md b/docs/api/browser/getHTML.md
@@ -18,6 +18,7 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
+
 ### Examples :
 
 ```js
@@ -37,11 +38,3 @@ console.log(htmlContent)
 
 The codebolt.browser.getHTML() function is used to retrieve the HTML content of the current web page. This function is particularly useful for web scraping, data extraction, and automated testing scenarios where you need to capture the entire HTML structure and content of a web page for further analysis or processing.
 
-
-### Explaination of the code: 
-
-Navigation: The script begins by navigating to the specific blog page using codebolt.browser.goToPage("https://example-blog.com/article").
-
-HTML Content Retrieval: Once the page has fully loaded, the script uses codebolt.browser.getHTML() to retrieve the complete HTML content of the current page. The function returns a promise that resolves to the HTML content, which includes all HTML tags, embedded styles, scripts, and textual content.
-
-Processing the Retrieved HTML: The retrieved HTML content is stored in the variable htmlContent. In this example, the script logs the HTML content to the console using console.log(htmlContent). Additionally, the example demonstrates how to save the HTML content to a file using Node.js's file system module (fs), which writes the HTML content to a file named product-page.html.
diff --git a/docs/api/browser/getMarkdown.md b/docs/api/browser/getMarkdown.md
@@ -39,16 +39,6 @@ console.log(markdownContent);
 The codebolt.browser.getMarkdown() function is used to retrieve the Markdown representation of the content on the current web page. This function is particularly useful for converting HTML content into a more readable and editable Markdown format, which is widely used in documentation, blogging, and content management systems.
 
 
-### Explanation of the Code
-
-Navigation: The script starts by navigating to a specific blog post page using codebolt.browser.goToPage("https://example-blog.com/post/12345").
-
-
-Markdown Content Retrieval: Once the page has fully loaded, the script uses codebolt.browser.getMarkdown() to retrieve the content of the current page in Markdown format. This function converts the HTML content into Markdown, capturing the structure and text in a more readable format.
-
-
-Processing the Retrieved Markdown: The retrieved Markdown content is stored in the variable markdownContent. In this example, the script logs the Markdown content to the console using console.log(markdownContent). Additionally, the example demonstrates how to save the Markdown content to a file using Node.js's file system module (fs), which writes the content to a file named post.md.
-
 
 
 
diff --git a/docs/api/browser/getPDF.md b/docs/api/browser/getPDF.md
@@ -16,32 +16,7 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Examples:
 
-```js
+### Status 
+Working Progress...
 
-// Navigate to the news article page
-await codebolt.browser.goToPage("https://example-news.com/article/12345");
-
-// Retrieve the PDF content of the current page
-const pdfContent = await codebolt.browser.getPDF();
-
-// Log a message to indicate the PDF has been retrieved (optional)
-console.log("PDF content retrieved successfully");
-
-```
-
-
-### Explanation
-
-The codebolt.browser.getPDF() function is used to retrieve a PDF representation of the current web page. This function is particularly useful for generating PDF versions of web pages for documentation, archiving, or sharing purposes. It captures the visual layout and content of the web page as a PDF file.
-
-
-
-### Explanation of the Code
-
-Navigation: The script starts by navigating to a specific news article page using codebolt.browser.goToPage("https://example-news.com/article/12345").
-
-PDF Content Retrieval: Once the page has fully loaded, the script uses codebolt.browser.getPDF() to retrieve the content of the current page as a PDF. This function captures the entire visual layout and content of the page, creating a PDF file that mirrors the web page's appearance.
-
-Processing the Retrieved PDF: The retrieved PDF content is stored in the variable pdfContent. In this example, the script logs a message to the console to indicate that the PDF has been successfully retrieved.
diff --git a/docs/api/browser/getUrl.md b/docs/api/browser/getUrl.md
@@ -34,11 +34,4 @@ console.log(`Current URL: ${currentUrl}`);
 
 ### Explanation
 
-The codebolt.browser.getUrl() function is used to retrieve the URL of the current active page in the browser. This function is useful in web automation, testing, and navigation scenarios where you need to confirm or log the URL of the page that the browser is currently displaying.
-
-
-### Explanation of the Code
-Navigation to Home Page: The script begins by navigating to the home page of the website using codebolt.browser.goToPage("https://example-website.com").
-
-Retrieving the Current URL: After the page has loaded, the script uses codebolt.browser.getUrl() to retrieve the current URL of the browser's active page. The retrieved URL is stored in the variable currentUrl.
-
+The codebolt.browser.getUrl() function is used to retrieve the URL of the current web page in the browser. This function returns the url, which we can store in a variable and use.
diff --git a/docs/api/browser/pdfToText.md b/docs/api/browser/pdfToText.md
@@ -16,7 +16,12 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Examples: 
+
+### Status 
+
+Working Progress...
+
+<!-- ### Examples: 
 
 ```js
 
@@ -29,4 +34,4 @@ codebolt.browser.pdfToText();
 ```
 
 ### Explanation
-The codebolt.browser.pdfToText() function is used to convert the PDF content of the current page into text format. This function is particularly useful when dealing with PDF documents in web automation or data extraction scenarios where you need to extract textual information from PDF files.
+The codebolt.browser.pdfToText() function is used to convert the PDF content of the current page into text format. This function is particularly useful when dealing with PDF documents in web automation or data extraction scenarios where you need to extract textual information from PDF files. -->
diff --git a/docs/api/browser/screenshot.md b/docs/api/browser/screenshot.md
@@ -16,7 +16,11 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Examples: 
+### Status 
+
+Working Progress...
+
+<!-- ### Examples: 
 
 ```js 
 
@@ -36,4 +40,4 @@ The codebolt.browser.screenshot() function is used to capture a screenshot of th
 
 Navigation: The script navigates to the desired web page using codebolt.browser.goToPage("https://example.com").
 
-Screenshot Capture: Once the page has loaded, the script calls codebolt.browser.screenshot() to capture a screenshot of the current page. This function takes a snapshot of the entire visible area of the web page, including all visible elements and content.
+Screenshot Capture: Once the page has loaded, the script calls codebolt.browser.screenshot() to capture a screenshot of the current page. This function takes a snapshot of the entire visible area of the web page, including all visible elements and content. -->
diff --git a/docs/api/browser/scroll.md b/docs/api/browser/scroll.md
@@ -33,17 +33,9 @@ data:
 // Scroll down the page by 500 pixels
 await codebolt.browser.scroll("down", "500");
 
-// Scroll up the page by 200 pixels
-await codebolt.browser.scroll("up", "200");
 
 ```
 
 ### Explanation:
 
 The codebolt.browser.scroll(direction: string, pixels: string) function is used to scroll the current page in a specified direction by a specified number of pixels. This function is useful for automating scrolling actions on a web page, such as navigating through lengthy content or bringing specific elements into view.
-
-### Explanation of the code:
- 
-Scrolling Down: The script calls codebolt.browser.scroll("down", "500") to scroll down the page by 500 pixels. This action brings more content into view, loading additional elements if the page supports dynamic loading or infinite scrolling.
-
-Scrolling Up: Next, the script calls codebolt.browser.scroll("up", "200") to scroll up the page by 200 pixels. This action moves the viewport upward, potentially revealing content that was previously out of view.
diff --git a/docs/api/browser/search.md b/docs/api/browser/search.md
@@ -39,10 +39,4 @@ console.log(searchResults);
 
 ### Explanation: 
 
-The codebolt.browser.search(elementid: string, query: string) function is used to perform a search on the current page using a specified query. This function allows automation scripts to search for specific content or elements within the page, facilitating tasks such as data extraction, validation, or interaction.
-
-
-### Explanation of the code: 
-Performing a Search: The script calls codebolt.browser.search("searchBox", "example query") to perform a search using the search box element with the ID "searchBox" and the query "example query". The function returns a Promise that resolves with the search results.
-
-Processing Search Results: Once the search results are obtained, the script can process them as needed. This may include validating the presence of specific search results, extracting data from the results, or performing further actions based on the search outcome. 
+The codebolt.browser.search(elementid: string, query: string) function is used to perform a search on the current page using a specified query. This function allows automation scripts to search for specific content or elements within the page.
diff --git a/docs/api/browser/type.md b/docs/api/browser/type.md
@@ -25,8 +25,6 @@ data:
  <CBParameters/>
 
 
-
-
 ### Examples: 
 
 ```js
@@ -43,13 +41,4 @@ await codebolt.browser.type("password", "password123");
 
 ### Explanation
 
-
-The codebolt.browser.type(elementid: string, text: string) function is used to simulate typing text into a specified element on the current web page. This function is essential for automating form submissions, text input fields, or any interaction that involves entering textual data.
-
-
-### Explanation of the code
-  
-
-Typing into Input Fields: The script uses codebolt.browser.type(elementid, text) to simulate typing text into specific input fields on the web page. Each call to codebolt.browser.type() specifies the ID of the target element (e.g., input field) and the text to be entered.
-
-Form Filling: In this example, the script fills out a registration form by typing text into input fields for name, email, and password. This simulates user input and allows the automation script to interact with the web page as if a user were manually entering the information.
+The codebolt.browser.type(elementid: string, text: string) function is used to put  text into a specified element on the current web page. the type() have two parameter one is elementid and second is value. we can put the value automatic using this type() function.
diff --git a/docs/api/cbstate/addToAgentState.md b/docs/api/cbstate/addToAgentState.md
@@ -22,4 +22,20 @@ data:
   link: addToAgentState.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Examples: 
+```js
+// Add a user ID to the agent's state
+await codebolt.cbstate.addToAgentState("userID", "12345");
+
+// Add a configuration setting to the agent's state
+await codebolt.cbstate.addToAgentState("configSetting", "darkModeEnabled");
+
+```
+
+### Explanation
+The codebolt.cbstate.addToAgentState(key: string, value: string) function is used to set key-value pair to the current agent's state. This function allows you to store state information.
+
+
+
diff --git a/docs/api/cbstate/getAgentState.md b/docs/api/cbstate/getAgentState.md
@@ -16,4 +16,26 @@ data:
   link: getAgentState.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+
+### Examples: 
+
+```js
+
+// Retrieve the current state of the agent
+const agentState = await codebolt.cbstate.getAgentState();
+
+// Access specific state information
+const userID = agentState.userID;
+const configSetting = agentState.configSetting;
+
+// Log the retrieved state information
+console.log(`User ID: ${userID}`);
+console.log(`Configuration Setting: ${configSetting}`);
+
+```
+
+### Explanation
+
+The codebolt.cbstate.getAgentState() function is used to retrieve the current state of the agent. If we are currently set in the agent's state, then we can access this value using getAgentState()
diff --git a/docs/api/cbstate/getApplicationState.md b/docs/api/cbstate/getApplicationState.md
@@ -16,4 +16,24 @@ data:
   link: getApplicationState.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Examples
+
+```js
+// Retrieve the current application state
+const appState = await codebolt.cbstate.getApplicationState();
+
+// Access specific state information
+const appVersion = appState.appVersion;
+const featureToggle = appState.featureToggle;
+
+// Log the retrieved state information
+console.log(`Application Version: ${appVersion}`);
+console.log(`Feature Toggle: ${featureToggle}`);
+
+```
+
+### Explanation
+
+The codebolt.cbstate.getApplicationState() function is used to get all the state information that store in the entire agent's state. This function is used to access shared state information relevant to the entire application.
diff --git a/docs/api/chat/eventEmitter.md b/docs/api/chat/eventEmitter.md
diff --git a/docs/api/chat/getChatHistory.md b/docs/api/chat/getChatHistory.md
diff --git a/docs/api/chat/processStarted.md b/docs/api/chat/processStarted.md
diff --git a/docs/api/chat/sendMessage.md b/docs/api/chat/sendMessage.md
diff --git a/docs/api/chat/stopProcess.md b/docs/api/chat/stopProcess.md
diff --git a/static/img/processStarted.png b/static/img/processStarted.png
diff --git a/static/img/sendMessage.png b/static/img/sendMessage.png
