updated docs

Author: Nursid

docs/api/apiaccess/browser/click.md

@@ -19,6 +19,23 @@ data:
 <CBBaseInfo/>
 <CBParameters/>
 
+### Response Structure
+
+The method returns a Promise that resolves to a `BrowserActionResponseData` object with the following properties:
+
+- **`type`** (string): Always "clickResponse".
+- **`payload`** (object, optional): Contains the response data including:
+  - **`action`** (string, optional): The action that was performed
+  - **`success`** (boolean, optional): Indicates if the click was successful
+  - **`content`** (string, optional): Additional content information
+  - **`viewport`** (object, optional): Current viewport information
+- **`eventId`** (string, optional): Event identifier for the click action
+- **`success`** (boolean, optional): Indicates if the operation was successful
+- **`message`** (string, optional): A message with additional information
+- **`error`** (string, optional): Error details if the operation failed
+- **`messageId`** (string, optional): A unique identifier for the message
+- **`threadId`** (string, optional): The thread identifier
+
 ### Example
 
 ```js
@@ -30,10 +47,23 @@ await new Promise(resolve => setTimeout(resolve, 2000));
 const clickResult = await codebolt.browser.click("submit-btn");
 console.log('✅ Clicked:', clickResult);
 
+// Check if the click was successful
+if (clickResult.success) {
+  console.log('Click action completed successfully');
+} else {
+  console.error('Click failed:', clickResult.error);
+}
+
 // Click on a link with a specific ID
 await codebolt.browser.click("nav-link");
 
 // Click on a checkbox or radio button
 await codebolt.browser.click("checkbox-id");
 ```
 
+### Notes
+
+- The `elementid` parameter must correspond to an existing element ID on the current page
+- The element must be visible and clickable for the operation to succeed
+- The response provides confirmation of the click action and any relevant page state changes
+

docs/api/apiaccess/browser/close.md

@@ -16,6 +16,10 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
+### Response Structure
+
+This method returns `void` and does not provide a response. The browser page is closed immediately when the method is called.
+
 ### Example
 
 ```js
@@ -30,4 +34,11 @@ await new Promise(resolve => setTimeout(resolve, 2000));
 // Close the browser when done
 codebolt.browser.close();
 console.log('✅ Browser closed');
-```
+```
+
+### Notes
+
+- This method does not return a Promise and executes immediately
+- The browser page is closed without waiting for confirmation
+- Use this method when you're finished with browser automation to clean up resources
+- After closing, you'll need to call `newPage()` again to create a new browser session

docs/api/apiaccess/browser/enter.md

@@ -16,6 +16,23 @@ data:
 <CBBaseInfo/> 
 <CBParameters/>
 
+### Response Structure
+
+The method returns a Promise that resolves to a `BrowserActionResponseData` object with the following properties:
+
+- **`type`** (string): Always "EnterResponse".
+- **`payload`** (object, optional): Contains the response data including:
+  - **`action`** (string, optional): The action that was performed
+  - **`success`** (boolean, optional): Indicates if the Enter key press was successful
+  - **`content`** (string, optional): Additional content information
+  - **`viewport`** (object, optional): Current viewport information
+- **`eventId`** (string, optional): Event identifier for the Enter action
+- **`success`** (boolean, optional): Indicates if the operation was successful
+- **`message`** (string, optional): A message with additional information
+- **`error`** (string, optional): Error details if the operation failed
+- **`messageId`** (string, optional): A unique identifier for the message
+- **`threadId`** (string, optional): The thread identifier
+
 ### Example
 
 ```js
@@ -31,7 +48,20 @@ await codebolt.browser.type("password", "testpass");
 const enterResult = await codebolt.browser.enter();
 console.log('✅ Enter key pressed:', enterResult);
 
+// Check if the Enter key press was successful
+if (enterResult.success) {
+  console.log('Enter key pressed successfully');
+} else {
+  console.error('Enter key press failed:', enterResult.error);
+}
+
 // Alternative usage: after typing in a search box
 await codebolt.browser.type("search-input", "search query");
 await codebolt.browser.enter(); // Submit the search
 ```
+
+### Notes
+
+- The Enter key press is applied to the currently focused element on the page
+- This is commonly used to submit forms or trigger search functionality
+- Ensure the appropriate element has focus before calling this method

docs/api/apiaccess/browser/extractText.md

@@ -16,6 +16,19 @@ data:
 <CBBaseInfo/> 
 <CBParameters/>
 
+### Response Structure
+
+The method returns a Promise that resolves to an `ExtractTextResponse` object with the following properties:
+
+- **`type`** (string): Always "extractTextResponse".
+- **`text`** (string, optional): The extracted text content from the current page
+- **`content`** (string, optional): Alternative property for the extracted text
+- **`success`** (boolean, optional): Indicates if the operation was successful
+- **`message`** (string, optional): A message with additional information
+- **`error`** (string, optional): Error details if the operation failed
+- **`messageId`** (string, optional): A unique identifier for the message
+- **`threadId`** (string, optional): The thread identifier
+
 ### Example 
 
 ```js
@@ -36,6 +49,8 @@ console.log('✅ Text extracted:', {
 if (textResult.success && textResult.text) {
     console.log('Extracted text:', textResult.text);
     // Process the text as needed for analysis or storage
+} else {
+    console.error('Failed to extract text:', textResult.error);
 }
 ```
 

docs/api/apiaccess/browser/getBrowserInfo.md

@@ -16,6 +16,34 @@ data:
 <CBBaseInfo/> 
 <CBParameters/>
 
+### Response Structure
+
+The method returns a Promise that resolves to a `BrowserInfoResponse` object with the following properties:
+
+- **`type`** (string): Always "getBrowserInfoResponse".
+- **`payload`** (object, optional): Contains the response data including:
+  - **`info`** (object): Browser viewport information with the following properties:
+    - **`width`** (number): Browser viewport width in pixels
+    - **`height`** (number): Browser viewport height in pixels
+    - **`devicePixelRatio`** (number): Device pixel ratio
+    - **`scrollX`** (number): Horizontal scroll position
+    - **`scrollY`** (number): Vertical scroll position
+    - **`pageYOffset`** (number): Page Y offset
+    - **`pageXOffset`** (number): Page X offset
+    - **`windowWidth`** (number): Window width
+    - **`windowHeight`** (number): Window height
+    - **`offsetHeight`** (number): Element offset height
+    - **`scrollHeight`** (number): Total scrollable height
+  - **`success`** (boolean, optional): Indicates if the operation was successful
+  - **`content`** (string, optional): Additional content information
+  - **`viewport`** (object, optional): Alternative viewport information
+- **`eventId`** (string, optional): Event identifier for the action
+- **`success`** (boolean, optional): Indicates if the operation was successful
+- **`message`** (string, optional): A message with additional information
+- **`error`** (string, optional): Error details if the operation failed
+- **`messageId`** (string, optional): A unique identifier for the message
+- **`threadId`** (string, optional): The thread identifier
+
 ### Example 
 
 ```js 
@@ -30,8 +58,22 @@ const browserInfoResult = await codebolt.browser.getBrowserInfo();
 console.log('✅ Browser info:', browserInfoResult);
 
 // The browser info contains viewport and scroll data
-if (browserInfoResult.success) {
-    console.log('Browser dimensions and scroll position:', browserInfoResult);
-    // Example output structure: { height: 800, width: 1200, scrollX: 0, scrollY: 50 }
+if (browserInfoResult.success && browserInfoResult.payload?.info) {
+    const info = browserInfoResult.payload.info;
+    console.log('Browser dimensions and scroll position:', {
+        width: info.width,
+        height: info.height,
+        scrollX: info.scrollX,
+        scrollY: info.scrollY,
+        scrollHeight: info.scrollHeight
+    });
+} else {
+    console.error('Failed to get browser info:', browserInfoResult.error);
 }
 ```
+
+### Notes
+
+- The browser info provides comprehensive viewport and scroll information
+- This is useful for responsive design testing, scroll position tracking, and viewport-based automation
+- The response includes both current viewport dimensions and total page dimensions

docs/api/apiaccess/browser/getHTML.md

@@ -16,6 +16,19 @@ data:
 <CBBaseInfo/> 
 <CBParameters/>
 
+### Response Structure
+
+The method returns a Promise that resolves to a `HtmlReceived` object with the following properties:
+
+- **`type`** (string): Always "htmlReceived".
+- **`html`** (string, optional): The HTML content of the current page
+- **`content`** (string, optional): Alternative property for the HTML content
+- **`success`** (boolean, optional): Indicates if the operation was successful
+- **`message`** (string, optional): A message with additional information
+- **`error`** (string, optional): Error details if the operation failed
+- **`messageId`** (string, optional): A unique identifier for the message
+- **`threadId`** (string, optional): The thread identifier
+
 ### Example
 
 ```js
@@ -36,5 +49,13 @@ console.log('✅ HTML retrieved:', {
 if (htmlResult.success && htmlResult.html) {
     console.log('HTML content:', htmlResult.html);
     // Process the HTML as needed
+} else {
+    console.error('Failed to retrieve HTML:', htmlResult.error);
 }
 ```
+
+### Notes
+
+- The HTML content includes the complete source code of the current page
+- This is useful for parsing page structure, extracting specific elements, or analyzing page content
+- The response may contain large amounts of data depending on the page size

docs/api/apiaccess/browser/getMarkdown.md

@@ -16,6 +16,19 @@ data:
 <CBBaseInfo/> 
 <CBParameters/>
 
+### Response Structure
+
+The method returns a Promise that resolves to a `GetMarkdownResponse` object with the following properties:
+
+- **`type`** (string): Always "getMarkdownResponse".
+- **`markdown`** (string, optional): The Markdown content of the current page
+- **`content`** (string, optional): Alternative property for the Markdown content
+- **`success`** (boolean, optional): Indicates if the operation was successful
+- **`message`** (string, optional): A message with additional information
+- **`error`** (string, optional): Error details if the operation failed
+- **`messageId`** (string, optional): A unique identifier for the message
+- **`threadId`** (string, optional): The thread identifier
+
 ### Example
 
 ```js
@@ -36,9 +49,17 @@ console.log('✅ Markdown retrieved:', {
 if (markdownResult.success && markdownResult.markdown) {
     console.log('Markdown content:', markdownResult.markdown);
     // Save or process the Markdown as needed
+} else {
+    console.error('Failed to retrieve Markdown:', markdownResult.error);
 }
 ```
 
+### Notes
+
+- The Markdown content is a structured text representation of the page content
+- This is useful for documentation, content analysis, or converting web content to readable format
+- The conversion maintains the logical structure of headings, lists, links, and other elements
+
 
 
 

docs/api/apiaccess/browser/getPDF.md

@@ -16,17 +16,28 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Example
+### Response Structure
 
-```js
+This method returns `void` and does not provide a response. The PDF generation is initiated immediately when the method is called.
 
-await codebolt.browser.goToPage("https://example-ecommerce.com/product/12345")
+### Example
 
+```js
+// Navigate to a page
+await codebolt.browser.goToPage("https://example-ecommerce.com/product/12345");
 
-const getPDF = await codebolt.browser.getPDF()
+// Wait for page to load
+await new Promise(resolve => setTimeout(resolve, 2000));
 
+// Generate PDF of the current page
+codebolt.browser.getPDF();
+console.log('✅ PDF generation initiated');
 ```
 
-### Explaination 
+### Notes
 
-The codebolt.browser.getPDF() method is designed to capture the content of the current webpage and generate a PDF file from it. This is useful for saving web pages as PDFs for offline reading, documentation, or record-keeping.
+- This method does not return a Promise and executes immediately
+- The PDF generation is initiated without waiting for confirmation
+- The generated PDF is typically saved to the default download location
+- This is useful for saving web pages as PDFs for offline reading, documentation, or record-keeping
+- Ensure the page is fully loaded before calling this method for best results

docs/api/apiaccess/browser/getSnapShot.md

@@ -16,6 +16,36 @@ data:
 <CBBaseInfo/> 
 <CBParameters/>
 
+### Response Structure
+
+The method returns a Promise that resolves to a `BrowserSnapshotResponse` object with the following properties:
+
+- **`type`** (string): Always "getSnapShotResponse".
+- **`payload`** (object, optional): Contains the response data including:
+  - **`tree`** (object): DOM tree structure with the following properties:
+    - **`strings`** (array): Array of strings used in the DOM tree
+    - **`documents`** (array): Array of document objects containing:
+      - **`nodes`** (object): Node information including:
+        - **`backendNodeId`** (array): Backend node identifiers
+        - **`attributes`** (array): Element attributes with name/value pairs
+        - **`nodeValue`** (array): Node values
+        - **`parentIndex`** (array): Parent node indices
+        - **`nodeType`** (array): Node types
+        - **`nodeName`** (array): Node names
+        - **`isClickable`** (object): Clickable element information
+        - **`textValue`** (object): Text content values
+        - **`inputValue`** (object): Input field values
+        - **`inputChecked`** (object): Checkbox/radio button states
+  - **`success`** (boolean, optional): Indicates if the operation was successful
+  - **`content`** (string, optional): Additional content information
+  - **`viewport`** (object, optional): Viewport information
+- **`eventId`** (string, optional): Event identifier for the action
+- **`success`** (boolean, optional): Indicates if the operation was successful
+- **`message`** (string, optional): A message with additional information
+- **`error`** (string, optional): Error details if the operation failed
+- **`messageId`** (string, optional): A unique identifier for the message
+- **`threadId`** (string, optional): The thread identifier
+
 ### Example 
 
 ```js 
@@ -30,10 +60,24 @@ const snapshotResult = await codebolt.browser.getSnapShot();
 console.log('✅ Snapshot taken:', snapshotResult);
 
 // The snapshot contains comprehensive page state information
-if (snapshotResult.success) {
-    console.log('Snapshot data available for analysis');
+if (snapshotResult.success && snapshotResult.payload?.tree) {
+    const tree = snapshotResult.payload.tree;
+    console.log('Snapshot data available for analysis:', {
+        documentsCount: tree.documents?.length || 0,
+        stringsCount: tree.strings?.length || 0,
+        hasNodeData: !!tree.documents?.[0]?.nodes
+    });
     // Process the snapshot data as needed
+} else {
+    console.error('Failed to get snapshot:', snapshotResult.error);
 }
 ```
 
+### Notes
+
+- The snapshot provides a complete structural representation of the page's DOM
+- This is useful for page analysis, element detection, and automated testing
+- The tree structure includes element hierarchy, attributes, and interactive states
+- The response contains detailed information about clickable elements and input values
+