Updated documents

docs/API/burpkit-api.md

@@ -0,0 +1,278 @@
+## `httpGetBytes(String url)`
+Makes an HTTP GET request for the given URL void of the same-origin policy.
+
+**Parameters:**
+
+*  `url` - the URL to fetch content from.
+
+**Returns:**
+A Java `byte[]` containing the HTTP response.
+
+**Example:**
+```javascript
+var responseBytes = burpKit.httpGetBytes('http://www.google.com');
+```
+
+---
+
+## `httpGetString(String url)`
+Makes an HTTP GET request for the given URL void of the same-origin policy.
+
+**Parameters:**
+
+*  `url` - the URL to fetch content from.
+
+**Returns:**
+A string containing the HTTP response.
+
+**Example:**
+```javascript
+var responseStr = burpKit.httpGetString('http://www.google.com');
+```
+
+---
+
+## `require(String url)`
+Executes the contents of the JavaScript script file located at the given URL in the context of the current DOM. 
+
+**Parameters:**
+
+*  `url` - the URL to fetch the JavaScript script contents from.
+
+**Example:**
+```javascript
+burpKit.require('https://code.jquery.com/jquery-2.1.4.js');
+```
+
+---
+
+## `requireLib(String library)`
+Injects the library identified by the `library` parameter into the current DOM. See the parameters description for a list
+of valid libraries that come pre-packaged with BurpKit. The library is usually contained within a `window.<libname>` object, 
+with exception to the jQuery library which is directly injected into the DOM.
+
+**Parameters:**
+
+*  `library` - the name of the library you'd like to inject. Valid values are `'csvlib'`, `'httplib'`, `'beautifylib'`, `'iplib'`, `'rotlib'`, `'structlib'`, `'jquery'`, and `'cryptolib'`. 
+
+**Example:**
+```javascript
+burpKit.require('csvlib'); // Can be accessed using window.csvlib
+burpKit.require('httplib'); // Can be accessed using window.httplib
+```
+
+---
+
+## `saveFileDialog(String title)`
+Opens a file save dialog with the specified title, allowing the user to choose where a file is to be saved.
+
+**Parameters:**
+
+*  `title` - the title of the save file dialog window. 
+
+**Returns:**
+The full path of the file to save contents to.
+
+**Example:**
+```javascript
+var csvFileName = burpKit.saveFileDialog('Where should we save your CSV?');
+```
+
+---
+
+## `openFileDialog(String title)`
+Opens a file open dialog with the specified title, allowing the user to choose a file to open.
+
+**Parameters:**
+
+*  `title` - the title of the open file dialog window. 
+
+**Returns:**
+The full path of the file to open.
+
+**Example:**
+```javascript
+var csvFileName = burpKit.openFileDialog('Where is your CSV?');
+```
+
+---
+
+## `openMultipleDialog(String title)`
+Just like the `fileOpenDialog()` but allows multiple file selections.
+
+**Parameters:**
+
+*  `title` - the title of the multiple open file dialog window. 
+
+**Returns:**
+An array of full path file names.
+
+**Example:**
+```javascript
+var csvFileNames = burpKit.openMultipleDialog('Where are your CSVs?');
+```
+
+---
+
+## `writeToFile(String file, String data)`
+Writes the contents of `data` to the file name specified in `file`. The file is opened and closed every time this method
+is called. If the file exists already, the contents of the existing file will be replaced with the contents of `data`.
+
+**Parameters:**
+
+*  `file` - the file path to write to.
+*  `data` - the data to write to file.
+
+**Example:**
+```javascript
+var fileName = burpKit.saveFileDialog('Save location...');
+burpKit.writeToFile(fileName, 'foo');
+```
+
+---
+
+## `appendToFile(String file, String data)`
+Appends the contents of `data` to the file name specified in `file`. The file is opened and closed every time this method
+is called.
+
+**Parameters:**
+
+*  `file` - the file path to write to.
+*  `data` - the data to append to file.
+
+**Example:**
+```javascript
+var fileName = burpKit.saveFileDialog('Save location...');
+burpKit.writeToFile(fileName, 'foo');
+burpKit.appendToFile(fileName, 'bar');
+```
+
+---
+
+## `readFromFile(String file)`
+The contents of the file specified by `file` are slurped into a string and returned. The file is opened and closed every
+time this method is invoked.
+
+**Parameters:**
+
+*  `file` - the file name to read data from.
+
+**Example:**
+```javascript
+var fileName = burpKit.openFileDialog('Select file...');
+alert(burpKit.readFromFile(fileName));
+```
+
+---
+
+## `loginPrompt(JSObject callback)`
+Prompts the user from login credentials. This can be used to write scripts that are driven by the BurpKit `document.onload`
+event loop.
+
+**Parameters:**
+
+*  `callback` - a callback function that accepts two parameters: `username` and `password`.
+
+**Example:**
+```javascript
+burpKit.loginPrompt(function(username, password) {
+    // Here we are leveraging jQuery to select, fill, and submit the login form.
+    // Luckily Twitter has already included jQuery as part of the page. 
+    var form = $('form.signin')[0];
+    $('[name="session[username_or_email]"]', form)[0].value = username;
+    $('[name="session[password]"]', form)[0].value = password;
+    locals.put('loopCount', loopCount + 1);
+    form.submit();
+});
+```
+
+---
+
+## `prompt(String question)`
+Prompts the user for input. Similar to `window.prompt()`.
+
+**Parameters:**
+
+*  `question` - the question that the user needs to provide input for.
+
+**Returns:**
+A string containing the answer.
+
+**Example:**
+```javascript
+var identity = burpKit.prompt("Who are you?");
+```
+
+---
+
+## `homeDirectory()`
+Returns the user's home directory. Useful for default file save locations.
+
+**Returns:**
+A string containing the user's home directory path.
+
+**Example:**
+```javascript
+var homeDir = burpKit.homeDirectory();
+```
+
+---
+
+## `pathJoin(String first, JSObject pathList)`
+Joins the paths in `first` and `pathList` using the native OS separator character.
+
+**Parameters:**
+
+*  `first` - the first part of the path (i.e. '/Users')
+*  `pathList` - an array of paths to join (i.e. ['foo', 'bar'])
+
+**Returns:**
+A string with the joined path.
+
+**Example:**
+```javascript
+burpKit.pathJoin('/Users', ['foo', 'bar']); // returns '/Users/foo/bar'
+```
+
+---
+
+## `locals()` and `globals()`
+Returns a global Java `Map` object that persists between `document.onload` events. `locals()` returns a map that is
+global to the current BurpKit tab, whereas `globals()` returns a map that is global to all of the BurpKit tabs. Values
+and names are strings, therefore the result of `toString()` will be stored where non-string objects are encountered.
+Persistence of complex objects can be achieved using a variety of string-based formats including XML, JSON, etc.
+
+**Returns:**
+A Java `Map` object that persists between page loads.
+
+**Example:**
+```javascript
+// Run in console.
+burpKit.locals().set('foo', 'bar');
+document.location = 'http://www.google.ca';
+burpKit.locals().get('foo') // returns 'bar'
+```
+
+--- 
+
+## `createJMenuItem(String caption, JSObject handler)`
+Creates a `JMenuItem` component that is useful for creating context menu items for BurpSuite plugins. 
+
+**Parameters:**
+
+*  `caption` - the label of the menu item
+*  `handler` - an object that adheres to the `ActionListener` interface or a lambda function that accepts an `ActionEvent` argument.
+
+**Example:**
+```javascript
+burpKit.createJMenuItem('Test', function(event) { alert('clicked!'); });
+});
+```
+
+or 
+
+```javascript
+burpKit.createJMenuItem('Test', {
+    'actionPerformed': function(event) { alert('clicked!'); }
+});
+```

docs/API/burpkit-overview.md

@@ -0,0 +1,26 @@
+The `burpKit` object provides language extensions to the JavaScript engine. These extensions provide developers with
+the ability to write and read files to and from the filesystem, inject arbitrary JavaScript libraries into the DOM, or
+perform HTTP requests regardless of same-origin policies. `burpKit` is automatically injected into the DOM after every
+`document.onload` event. The following example is a small snippet that demonstrates some of the API features that are part
+of the `burpKit` object:
+
+```javascript
+var fileName = burpKit.saveFileDialog("Where would you like to save the file contents?");
+
+if (fileName != null) {
+    burpKit.requireLib('csvlib'); // inject a CSV library into the DOM
+
+    var csvData = [['Name', 'Value']]; // CSV title row
+    data.push(['foo', 'bar']); // arbitrary CSV data row
+
+    // Write results to CSV file
+    csvlib.stringify(
+        data, 
+        function(err, output) {
+            burpKit.writeToFile(fileName, output); 
+        }
+    );
+}
+```
+
+The following subsections details the methods that are part of the `burpKit` object.

docs/API/callbacks-overview.md

@@ -6,6 +6,7 @@ The `burpCallbacks` object is automatically injected into the DOM every time a `
 4. Methods with the same name but multiple signatures (i.e. `foo(String)`, `foo(String, int)`, etc.) are numbered due to limitations within JavaScript (i.e. `foo(String)`, `foo2(String, int)`, etc.).
 
 The following example demonstrates how one could easily create a simple proxy listener using JavaScript with the BurpKit extensions:
+
 ```javascript
 // inject an HTTP helper library for message parsing
 burpKit.requireLib('httplib');
@@ -25,4 +26,5 @@ burpCallbacks.registerProxyListener(function(isRequest, message) {
   }
 });
 ```
+
 This is just a simple example of how powerful BurpKit is. Many more examples can be found in the bundled [examples](https://github.com/allfro/BurpKit/tree/master/examples) directory that comes with BurpKit. The following subsections detail the methods available within the `burpCallbacks` object.

docs/burpScript.md

@@ -6,4 +6,4 @@ BurpScript is a JavaScript langauge extension that provides additional language
 *  BurpExtender - exposes the BurpSuite interface to the JS engine so that you can write your own BurpSuite plugins using JavaScript.
 
 BurpScript can be used to perform a variety of tasks ranging from OSINT automation scripts to full-fledged BurpSuite
-extensions. Take a look at the `examples` folder in the code repository to see how BurpKit can be leveraged.
+extensions. Take a look at the [examples](https://github.com/allfro/BurpKit/tree/master/examples) folder in the code repository to see how BurpKit can be leveraged.

mkdocs.yml

@@ -8,7 +8,10 @@ theme: readthedocs
 pages:
 - Home: index.md
 - BurpScript: burpScript.md
-- API: 
+- API:
+    - burpKit object:
+        - Overview: API/burpkit-overview.md
+        - Methods: API/burpkit-api.md
     - burpCallbacks object: 
         - Overview: API/callbacks-overview.md
         - Methods: API/callbacks-api.md