Pre and Post Script plugin documentation (#36)

Pre and Post script

Author: davinder-sudo

docs/core-features-section/voiden-blocks/pre & post script/post-script.md

@@ -0,0 +1,35 @@
+---
+  id: post-script
+  title: Post Script
+  sidebar_label: Post Script Blocks
+---
+
+#  <div style={{display:"flex",alignItems:"center"}}> Post Script <small style={{alignSelf:"start",fontSize:"12px",marginLeft:"10px",padding:"5px",background:"#8a5cf67d",display:"flex",alignItems:"cetner",gap:"5px",borderRadius:"10px"}}><img src="/img/flask-conical.svg" width="14" /> Beta only</small></div>
+
+> **Note:** This feature is currently in **Beta**.
+
+The **Post Script** block lets you run custom logic **after a response is received**.
+
+It executes locally inside Voiden in an isolated environment. Use it to validate responses, extract values, store runtime variables, or write logs.
+
+Voiden supports **JavaScript** and **Python**.
+
+For a full reference of what you can do inside a script, see the [Voiden Script Plugin](/docs/plugins/core-plugins/pre-post%20script/overview).
+
+---
+
+## How to Insert
+
+1. In your Voiden file, type `/post_script` and press **Enter**.
+
+    ![post-script](/img/voiden-blocks/post-scripts.png)
+
+2. Add your script logic inside the block.
+
+    ![post-done](/img/voiden-blocks/post-done.png)
+
+3. Run the request with **Cmd + Enter** (Mac) or **Ctrl + Enter** (Windows/Linux).
+
+    ![post-script-done](/img/voiden-blocks/post-script-done.png)
+
+4. View response and assertions in the **Response panel** and logs in the **Script Logs**.

docs/core-features-section/voiden-blocks/pre & post script/pre-script.md

@@ -0,0 +1,35 @@
+---
+  id: pre-script
+  title: Pre Script
+  sidebar_label: Pre Script Blocks
+---
+
+#  <div style={{display:"flex",alignItems:"center"}}> Pre Script <small style={{alignSelf:"start",fontSize:"12px",marginLeft:"10px",padding:"5px",background:"#8a5cf67d",display:"flex",alignItems:"cetner",gap:"5px",borderRadius:"10px"}}><img src="/img/flask-conical.svg" width="14" /> Beta only</small></div>
+
+> **Note:** This feature is currently in **Beta**.
+
+The **Pre Script** block lets you run custom logic **before a request is sent**.
+
+It executes locally inside Voiden — not on the API endpoint — in an isolated environment. Use it to dynamically prepare the request: generate tokens, update headers, set variables, or add conditional logic.
+
+Voiden supports **JavaScript** and **Python**.
+
+For a full reference of what you can do inside a script, see the [Voiden Script Plugin](/docs/plugins/core-plugins/pre-post%20script/overview).
+
+---
+
+## How to Insert
+
+1. In your Voiden file, type `/pre_script` and press **Enter**.
+
+    ![pre-script](/img/voiden-blocks/pre-script.png)
+
+2. Add your script logic inside the block.
+
+    ![pre-done](/img/voiden-blocks/pre-done.png)
+
+3. Run the request with **Cmd + Enter** (Mac) or **Ctrl + Enter** (Windows/Linux).
+
+    ![pre-script-done](/img/voiden-blocks/pre-script-done.png)
+
+4. View response and assertions in the **Response panel** and logs in the **Script Logs**.

docs/core-features-section/voiden-blocks/rest-blocks/xml-block.md

@@ -18,15 +18,15 @@ And when your tags get tangled? Hit **Prettify** in the top-right corner to form
 
 1. Type `/xml` to add an **XML Block** payload to your Voiden file
 
-![xml](/img/plugins/openapi-collection/xml-pre.png)
+![xml](/img/plugins/socket/xml-pre.png)
 
 2. Paste in (or type) the sample **XML**
 3. Hit **Cmd + Enter** (Mac) or **Ctrl + Enter**  (Windows/Linux) to run the request  
 **or** click the **green  Play button** in the toolbar.  
 
 ---
 
-![xml](/img/plugins/openapi-collection/xml-post.gif)
+![xml](/img/plugins/socket/xml-post.gif)
 >  **Pro Tip:** Want to comment out a line without overkill?  
 > Use **Cmd + /** (Mac) or **Ctrl + /** (Windows/Linux) to comment out an XML line you don't need for that payload.  
 > It’ll stay visible but won’t be sent with the request.  

docs/getting-started-section/getting-started/voiden-editor.md

@@ -0,0 +1,39 @@
+---
+id: voiden-editor
+title: The Voiden Editor
+sidebar_label: Voiden Editor
+---
+
+# The Voiden Editor
+
+Voiden ships with its own custom editor, built on top of **Tiptap**. It looks like a rich-text editor, but everything is saved as clean **Markdown** underneath — file-based, Git-friendly, and readable outside Voiden.
+
+![Voiden Editor](/img/geetingstarted/voideneditor.png)
+
+---
+
+## Block-Based Editing
+
+The editor is structured around **blocks**. Instead of one long file, you insert purpose-specific blocks:
+
+- Request blocks
+- Variable blocks
+- Assertion blocks
+- Script blocks
+- Markdown blocks
+
+Each block has a clear role, making files easy to scan even as they grow.
+
+---
+
+## Write and Document Together
+
+Requests, explanations, response comments, and usage notes all live in the same file — right next to each other.
+
+No context switching. No separate tools.
+
+---
+
+## Keyboard-Friendly
+
+Insert blocks with slash commands (e.g. `/endpoint`, `/headers`, `/json`), reorder them quickly, and run requests without leaving the editor.

docs/plugins/core-plugins/pre-post script/overview.md

@@ -0,0 +1,166 @@
+---
+  id: overview
+  title: Overview
+  sidebar_label: Overview
+  sidebar_position: 1
+---
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+#  <div style={{display:"flex",alignItems:"center"}}> Voiden Scripting <small style={{alignSelf:"start",fontSize:"12px",marginLeft:"10px",padding:"5px",background:"#8a5cf67d",display:"flex",alignItems:"cetner",gap:"5px",borderRadius:"10px"}}><img src="/img/flask-conical.svg" width="14" /> Beta only</small></div>
+
+> **Note:** This feature is currently in **Beta**.
+
+Voiden Scripting lets you run **JavaScript** or **Python** code as part of your request lifecycle, using the exposed `voiden` API.
+
+Scripts run at two stages:
+
+- [**Pre Script**](/docs/plugins/core-plugins/pre-post%20script/pre-script) — runs before the request is sent
+- [**Post Script**](/docs/plugins/core-plugins/pre-post%20script/post-script) — runs after the response is received
+
+Both stages share the same `voiden` API.
+
+Scripts run in an isolated environment. You have full freedom to use any library or perform any operation — Voiden simply exposes the `voiden` API on top of that.
+
+---
+
+## Blocks
+
+Voiden Scripting introduces two blocks you can add to your `.void` file:
+
+| Block | Description |
+|---|---|
+| [**Pre-Script**](/docs/plugins/core-plugins/pre-post%20script/pre-script) | Runs before the request is sent. Use it to modify headers, body, params, or cancel the request entirely. |
+| [**Post-Script**](/docs/plugins/core-plugins/pre-post%20script/post-script) | Runs after the response is received. Use it to assert values, extract data, and store variables for later requests. |
+
+---
+
+## How Scripts Run
+
+Voiden runs your scripts in an isolated environment so they can't interfere with the app. The way this works differs slightly between languages.
+
+**JavaScript** scripts are sent to a separate Node.js process. The `voiden` API (env, variables) communicates back to the app via message passing, so every API call returns a Promise. This is why you need `await`.
+
+**Python** scripts also run in a separate process, but before the script starts, Voiden pre-loads all your environment variables and runtime variables and passes them in directly. So the `voiden` API is just plain synchronous method calls — no `await` needed.
+
+<Tabs>
+  <TabItem value="js" label="JavaScript" default>
+    ```js
+    const token = await voiden.env.get("TOKEN");
+    const userId = await voiden.variables.get("userId");
+    ```
+  </TabItem>
+  <TabItem value="py" label="Python">
+    ```py
+    token = voiden.env.get("TOKEN")
+    user_id = voiden.variables.get("userId")
+    ```
+  </TabItem>
+</Tabs>
+
+---
+
+## Environment Variables
+
+Environment variables are read-only values configured in your active environment.
+
+<Tabs>
+  <TabItem value="js" label="JavaScript" default>
+    ```js
+    const token = await voiden.env.get("API_TOKEN");
+    ```
+  </TabItem>
+  <TabItem value="py" label="Python">
+    ```py
+    token = voiden.env.get("API_TOKEN")
+    ```
+  </TabItem>
+</Tabs>
+
+---
+
+## Runtime Variables
+
+Runtime variables are dynamic values you can create, read, and update during execution. They are useful for passing data between requests.
+
+<Tabs>
+  <TabItem value="js" label="JavaScript" default>
+    ```js
+    await voiden.variables.set("key", "value");
+    const val = await voiden.variables.get("key");
+    ```
+  </TabItem>
+  <TabItem value="py" label="Python">
+    ```py
+    voiden.variables.set("key", "value")
+    val = voiden.variables.get("key")
+    ```
+  </TabItem>
+</Tabs>
+
+![pre-runtime](/img/plugins/pre-post/output.gif)
+
+---
+
+## Logging
+
+Logs appear in Voiden's UI and help you debug, trace flow, or monitor values during script execution.
+
+<Tabs>
+  <TabItem value="js" label="JavaScript" default>
+    ```js
+    voiden.log("message");
+    voiden.log("info", "pre-script ran");
+    voiden.log("warn", "token missing");
+    voiden.log("error", "request aborted");
+    voiden.log("debug", "body:", voiden.request.body);
+    ```
+  </TabItem>
+  <TabItem value="py" label="Python">
+    ```py
+    voiden.log("message")
+    voiden.log("info", "pre-script ran")
+    voiden.log("warn", "token missing")
+    voiden.log("error", "request aborted")
+    voiden.log("debug", "body:", voiden.request.body)
+    ```
+  </TabItem>
+</Tabs>
+
+![Voiden Script Log](/img/plugins/pre-post/voiden-log.gif)
+
+**Supported levels:** `log` · `info` · `debug` · `warn` · `error`
+
+---
+
+## Assertions
+
+Assertions let you validate values and surface pass/fail results in the Response panel.
+
+![Voiden Script Assertion](/img/plugins/pre-post/voiden-script.png)
+
+```js
+voiden.assert(actual, operator, expectedValue, message);
+```
+
+| Parameter | Description |
+|---|---|
+| `actual` | The value to test (e.g. `voiden.response.status`) |
+| `operator` | Comparison operator (e.g. `"=="`, `"contains"`, `"greater"`) |
+| `expectedValue` | The value you expect |
+| `message` | (Optional) Label shown in the assertion result |
+
+<Tabs>
+  <TabItem value="js" label="JavaScript" default>
+    ```js
+    voiden.assert(voiden.response.status, "==", 200, "Status should be 200");
+    voiden.assert(voiden.response.body.name, "contains", "Voiden", "Name check");
+    ```
+  </TabItem>
+  <TabItem value="py" label="Python">
+    ```py
+    voiden.assert(voiden.response.status, "==", 200, "Status should be 200")
+    voiden.assert(voiden.response.body.name, "contains", "Voiden", "Name check")
+    ```
+  </TabItem>
+</Tabs>