thunderclient-mcp 1.0.12 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -140
- package/dist/index.js +3 -0
- package/dist/resources.d.ts +3 -0
- package/dist/resources.d.ts.map +1 -0
- package/dist/resources.js +191 -0
- package/dist/thunder-client.d.ts +190 -10
- package/dist/thunder-client.d.ts.map +1 -1
- package/dist/thunder-client.js +343 -57
- package/dist/tools/definitions.d.ts +805 -9
- package/dist/tools/definitions.d.ts.map +1 -1
- package/dist/tools/definitions.js +339 -42
- package/dist/utils/schema-converter.d.ts +2 -6
- package/dist/utils/schema-converter.d.ts.map +1 -1
- package/dist/utils/schema-converter.js +13 -41
- package/package.json +3 -2
- package/.claude/settings.local.json +0 -7
- package/public/copolit_add_mcp_server.png +0 -0
package/README.md
CHANGED
|
@@ -2,160 +2,33 @@
|
|
|
2
2
|
<img src="https://github.com/thunderclient/thunder-client-support/blob/21d62c97dcc8168dc678b165fe678fd12c2f476b/images/thunder-icon.png" width="120" height="120" />
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
|
-
|
|
6
5
|
# Thunder Client MCP Server
|
|
7
6
|
|
|
8
|
-
The Thunder Client MCP server
|
|
9
|
-
|
|
10
|
-
## Requirements
|
|
11
|
-
|
|
12
|
-
- A **Business** or **Enterprise** plan subscription is required to use the Thunder Client MCP Server.
|
|
13
|
-
- View Thunder Client pricing plans [here](https://www.thunderclient.com/pricing).
|
|
14
|
-
|
|
15
|
-
## Available Tools
|
|
16
|
-
|
|
17
|
-
This MCP server provides three powerful tools for managing Thunder Client operations:
|
|
18
|
-
|
|
19
|
-
### 1. `tc_create`
|
|
20
|
-
|
|
21
|
-
**Description:**
|
|
22
|
-
Saves API endpoints to Thunder Client, automatically creating collections and folders if they do not already exist.
|
|
23
|
-
|
|
24
|
-
**Usage:**
|
|
25
|
-
|
|
26
|
-
- Use AI to analyze your current project and automatically generate API requests in Thunder Client, with the appropriate collection and folder created as needed.
|
|
27
|
-
- Add new requests to a specific collection in Thunder Client.
|
|
28
|
-
- Dynamically create a request using an AI-generated prompt.
|
|
29
|
-
|
|
30
|
-
### 2. `tc_debug`
|
|
31
|
-
|
|
32
|
-
**Description:** Show Thunder Client CLI debug information using `tc --debug` in the given project directory.
|
|
33
|
-
|
|
34
|
-
- **Usage:** Troubleshoot and get detailed debug information from Thunder Client
|
|
35
|
-
|
|
36
|
-
|
|
7
|
+
The Thunder Client MCP server lets AI assistants create, manage, and run API requests and collections directly in Thunder Client — without leaving your editor.
|
|
37
8
|
|
|
38
|
-
|
|
9
|
+
Compatible with **Claude Code**, **Codex**, **GitHub Copilot**, **Cursor**, **Windsurf**, and any MCP-compatible AI tool.
|
|
39
10
|
|
|
40
|
-
|
|
11
|
+
## Documentation
|
|
41
12
|
|
|
42
|
-
|
|
43
|
-
2. Click on **Installed**
|
|
44
|
-
3. Click on **Configure the MCP Server**
|
|
45
|
-
4. Add the following configuration inside the `mcpServers` JSON:
|
|
46
|
-
|
|
47
|
-
```json
|
|
48
|
-
{
|
|
49
|
-
"mcpServers": {
|
|
50
|
-
"thunderclient": {
|
|
51
|
-
"name": "Thunder Client MCP Server",
|
|
52
|
-
"type": "stdio",
|
|
53
|
-
"command": "npx",
|
|
54
|
-
"args": ["-y", "thunderclient-mcp"]
|
|
55
|
-
}
|
|
56
|
-
}
|
|
57
|
-
}
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
**Important:** Replace `thunderclient-mcp` with `/path/to/thunder-mcp/dist/index.js` with your actual `index.js` location in local Dev mode.
|
|
61
|
-
|
|
62
|
-
Once configured, you can use all `tc_*` command tools in Cline's MCP interface.
|
|
13
|
+
For requirements, installation, and setup instructions, see the [Thunder Client MCP documentation](https://docs.thunderclient.com/mcp).
|
|
63
14
|
|
|
64
15
|
---
|
|
65
16
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
1. Add a new **MCP server** to your configuration
|
|
69
|
-
2. Switch to **Agent mode** instead of Chat mode
|
|
70
|
-
3. Configure using the following YAML structure:
|
|
71
|
-
|
|
72
|
-
```yaml
|
|
73
|
-
name: Thunder Client MCP Server
|
|
74
|
-
version: 0.0.1
|
|
75
|
-
schema: v1
|
|
76
|
-
mcpServers:
|
|
77
|
-
- name: Thunder Client MCP Server
|
|
78
|
-
command: npx
|
|
79
|
-
args:
|
|
80
|
-
- thunderclient-mcp
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
**Important:** Replace `thunderclient-mcp` with `/path/to/thunder-mcp/dist/index.js` with your actual `index.js` location in local Dev mode.
|
|
84
|
-
|
|
85
|
-
---
|
|
86
|
-
|
|
87
|
-
### For GitHub Copilot
|
|
88
|
-
|
|
89
|
-
1. Switch to **Agent mode** from Chat mode
|
|
90
|
-
2. Click on the **Tools** icon in the interface
|
|
91
|
-
3. Scroll down and click **+ Add more tools**
|
|
92
|
-
4. Select **+ Add MCP Server**
|
|
93
|
-

|
|
94
|
-
5. Choose **Stdio** as the connection type
|
|
95
|
-
6. Enter the command to run as `npx thunderclient-mcp`
|
|
96
|
-
7. Enter the mcp name `thunderclient-mcp-server-....`
|
|
97
|
-
8. Choose where to install MCP, select `Global` or `User`
|
|
98
|
-
9. Save the configuration
|
|
99
|
-
|
|
100
|
-
**Important:** Replace `npx thunderclient-mcp` with `node /path/to/thunder-mcp/dist/index.js` with your actual `index.js` location in local Dev mode.
|
|
101
|
-
|
|
102
|
-
# Example Prompts
|
|
103
|
-
|
|
104
|
-
This document contains simple example prompts for the `tc_create` tool to extract APIs from code files and save them to Thunder Client.
|
|
105
|
-
|
|
106
|
-
## Extract APIs from Code Files
|
|
107
|
-
|
|
108
|
-
### 1. Extract APIs from Current Project
|
|
109
|
-
|
|
110
|
-
```
|
|
111
|
-
"Get the endpoints from the current project and save them with collection name 'My API' using Thunder Client MCP."
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
### 2. Extract APIs from Files and Folders
|
|
115
|
-
|
|
116
|
-
```
|
|
117
|
-
"Get the endpoints from app/main.py and save them with collection name 'E-commerce API' and folder name 'Products' using Thunder Client MCP."
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
```
|
|
121
|
-
"Get the endpoints from the src/routes/ folder and save them with collection name 'Node API' using Thunder Client MCP."
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
### 3. Create Simple HTTP Requests
|
|
17
|
+
## Contributing
|
|
125
18
|
|
|
126
|
-
|
|
127
|
-
"Create a POST request to https://api.example.com/users with a JSON body and an Authorization header using Thunder Client MCP."
|
|
128
|
-
```
|
|
19
|
+
Issues and pull requests are welcome.
|
|
129
20
|
|
|
130
|
-
|
|
21
|
+
To build the server locally, run:
|
|
131
22
|
|
|
132
23
|
```bash
|
|
133
|
-
|
|
24
|
+
git clone https://github.com/thunderclient/thunderclient-mcp
|
|
25
|
+
cd thunderclient-mcp
|
|
26
|
+
npm install
|
|
134
27
|
npm run build
|
|
135
28
|
```
|
|
136
29
|
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
## Troubleshooting
|
|
140
|
-
|
|
141
|
-
### If the Agent Is Not Executing Commands Properly
|
|
142
|
-
|
|
143
|
-
1. **Use Attach Context:** Utilize the **Attach Context** option in your AI environment
|
|
144
|
-
2. **Attach Required Files:** Include relevant files and specifically attach the `tc_create` tool context
|
|
145
|
-
3. **Provide Clear Prompts:** Give detailed, specific prompts to assist with command execution
|
|
146
|
-
|
|
147
|
-
### Common Issues
|
|
148
|
-
|
|
149
|
-
- **Path Issues:** Ensure all file paths are absolute and correctly formatted for your operating system
|
|
150
|
-
- **Node.js Version:** Verify you're using a compatible Node.js version
|
|
151
|
-
- **Permissions:** Check that the MCP server has appropriate file system permissions
|
|
152
|
-
- **Project Directory:** Ensure the `projectDir` parameter points to a valid Thunder Client workspace
|
|
153
|
-
|
|
154
|
-
---
|
|
155
|
-
|
|
156
|
-
## Contributing
|
|
30
|
+
Then, in your MCP configuration, replace `npx -y thunderclient-mcp` with `node /path/to/thunderclient-mcp/dist/index.js`.
|
|
157
31
|
|
|
158
|
-
|
|
32
|
+
## License
|
|
159
33
|
|
|
160
|
-
|
|
161
|
-
[](https://mseep.ai/app/thunderclient-thunderclient-mcp)
|
|
34
|
+
This project is licensed under the [MIT License](LICENSE).
|
package/dist/index.js
CHANGED
|
@@ -4,6 +4,7 @@ import { Server } from "@modelcontextprotocol/sdk/server/index.js";
|
|
|
4
4
|
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
|
5
5
|
import { CallToolRequestSchema, ListToolsRequestSchema, } from "@modelcontextprotocol/sdk/types.js";
|
|
6
6
|
import { toolHandlers, tools } from "./tools/definitions.js";
|
|
7
|
+
import { registerResources } from "./resources.js";
|
|
7
8
|
import pkg from '../package.json' with { type: 'json' };
|
|
8
9
|
const version = pkg.version;
|
|
9
10
|
const thunderClient = new ThunderClient();
|
|
@@ -14,8 +15,10 @@ const server = new Server({
|
|
|
14
15
|
}, {
|
|
15
16
|
capabilities: {
|
|
16
17
|
tools: {},
|
|
18
|
+
resources: {},
|
|
17
19
|
},
|
|
18
20
|
});
|
|
21
|
+
registerResources(server);
|
|
19
22
|
server.setRequestHandler(ListToolsRequestSchema, async () => {
|
|
20
23
|
return {
|
|
21
24
|
tools
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["../src/resources.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAC;AAgLnE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,QAsB/C"}
|
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
import { ListResourcesRequestSchema, ReadResourceRequestSchema, } from "@modelcontextprotocol/sdk/types.js";
|
|
2
|
+
const TC_DOCS = `# Thunder Client — Overview and Guidelines
|
|
3
|
+
|
|
4
|
+
## What is Thunder Client?
|
|
5
|
+
|
|
6
|
+
Thunder Client is a lightweight REST API client for VS Code. It supports HTTP requests,
|
|
7
|
+
collections, environments, scripting, and test assertions — all stored as local JSON files
|
|
8
|
+
in the project's thunder-tests folder.
|
|
9
|
+
|
|
10
|
+
## Working with Thunder Client via MCP
|
|
11
|
+
|
|
12
|
+
All read and write operations must go through the provided MCP tools. Do not read, write,
|
|
13
|
+
or edit thunder-tests files or any Thunder Client data files directly. If an operation is
|
|
14
|
+
not supported by the available tools, inform the user and direct them to the Thunder Client UI.
|
|
15
|
+
|
|
16
|
+
## Tool Overview
|
|
17
|
+
|
|
18
|
+
| Tool | Purpose |
|
|
19
|
+
|---|---|
|
|
20
|
+
| debugInfo | Verify project setup, CLI version, collections, and environments |
|
|
21
|
+
| listCollections | Browse collections, folders, and requests |
|
|
22
|
+
| getDetails | Retrieve full details of any item by ID |
|
|
23
|
+
| listEnvironments | List environment names and active status |
|
|
24
|
+
| createCollection | Create a new collection, optionally with a folder |
|
|
25
|
+
| createFolder | Add a folder to a collection |
|
|
26
|
+
| createRequest | Import a request from a curl command |
|
|
27
|
+
| updateRequest | Update name, URL, method, headers, body, auth, or tests |
|
|
28
|
+
| updateCollectionSettings | Set collection or folder options, baseUrl, or rename |
|
|
29
|
+
| runRequest | Execute a single request |
|
|
30
|
+
| runCollection | Run a collection or folder |
|
|
31
|
+
| deleteRequest | Delete a request from a collection or the Activity tab |
|
|
32
|
+
|
|
33
|
+
## URL and baseUrl Convention
|
|
34
|
+
|
|
35
|
+
Set baseUrl on the collection using updateCollectionSettings, then use only the path in request URLs.
|
|
36
|
+
Thunder Client prepends baseUrl automatically at runtime.
|
|
37
|
+
|
|
38
|
+
Correct: url: "/users/{{userId}}"
|
|
39
|
+
Incorrect: url: "https://api.example.com/users/{{userId}}"
|
|
40
|
+
Incorrect: url: "{{baseUrl}}/users/{{userId}}"
|
|
41
|
+
|
|
42
|
+
After setting baseUrl, inform the user:
|
|
43
|
+
"I have set the base URL to 'https://api.example.com' in the collection settings."
|
|
44
|
+
|
|
45
|
+
## Token Flow Pattern
|
|
46
|
+
|
|
47
|
+
Step 1 — Create a login request with a postReq script to capture the token:
|
|
48
|
+
tc.setVar('accessToken', tc.response.json.token)
|
|
49
|
+
Inform the user: "An active environment is required for tc.setVar to persist the token."
|
|
50
|
+
|
|
51
|
+
Step 2 — Run the login request via runRequest.
|
|
52
|
+
The token is saved to the active environment as 'accessToken'.
|
|
53
|
+
|
|
54
|
+
Step 3 — Reference the token in subsequent requests:
|
|
55
|
+
auth: { type: "bearer", bearer: "{{accessToken}}" }
|
|
56
|
+
|
|
57
|
+
## Scripting API Reference
|
|
58
|
+
|
|
59
|
+
Full reference: https://docs.thunderclient.com/scripting
|
|
60
|
+
|
|
61
|
+
**Variables**
|
|
62
|
+
tc.setVar(name, value, scope?) — Save a value; scope: 'local' | 'global' | 'request' (default: active env)
|
|
63
|
+
tc.getVar(name) — Read a value from the active environment
|
|
64
|
+
tc.replaceVars(text) — Resolve {{varName}} placeholders in a string
|
|
65
|
+
|
|
66
|
+
**Request object** (preReq and postReq — read/modify before send)
|
|
67
|
+
tc.request.url — Request URL string
|
|
68
|
+
tc.request.method — HTTP method
|
|
69
|
+
tc.request.setHeader(name, val) — Set a request header
|
|
70
|
+
tc.request.getHeader(name) — Get a request header value
|
|
71
|
+
tc.request.setBody(body, type?) — Set the request body
|
|
72
|
+
tc.request.url.getParam(name) — Get a query parameter value
|
|
73
|
+
tc.request.url.setParam(name, v) — Set a query parameter value
|
|
74
|
+
|
|
75
|
+
**Response object** (postReq only)
|
|
76
|
+
tc.response.json — Parsed JSON body
|
|
77
|
+
tc.response.text — Raw body string
|
|
78
|
+
tc.response.status — HTTP status code (number)
|
|
79
|
+
tc.response.time — Response time in ms
|
|
80
|
+
tc.response.size — Response size in bytes
|
|
81
|
+
tc.response.contentType — Content-Type header value
|
|
82
|
+
tc.response.headers — Response headers object
|
|
83
|
+
tc.response.cookies — Response cookies
|
|
84
|
+
tc.response.getHeader(name) — Get a specific response header
|
|
85
|
+
tc.response.getBinary() — Get response as binary
|
|
86
|
+
|
|
87
|
+
**Assertions** (postReq)
|
|
88
|
+
tc.test(name, boolExpr) — Write a named test assertion
|
|
89
|
+
expect / assert — Chai assertion globals
|
|
90
|
+
|
|
91
|
+
**Info** (read-only, both)
|
|
92
|
+
tc.info.environmentName, tc.info.requestName, tc.info.collectionName
|
|
93
|
+
tc.info.folderName, tc.info.currentIteration, tc.info.totalIterations
|
|
94
|
+
|
|
95
|
+
**Control / Utilities**
|
|
96
|
+
tc.delay(ms) — Pause execution
|
|
97
|
+
tc.runRequest(reqId) — Run another request by ID
|
|
98
|
+
tc.retryRequest() — Retry the current request
|
|
99
|
+
tc.skipRequest(reqId) — Skip a request in a collection run
|
|
100
|
+
tc.getCookies(url?) — Get cookies
|
|
101
|
+
tc.setCookie(url, name, value) — Set a cookie
|
|
102
|
+
tc.readFile(path, encoding?) — Read a file
|
|
103
|
+
tc.loadModule(name) — Load a built-in npm module
|
|
104
|
+
|
|
105
|
+
**Built-in modules** (via tc.loadModule)
|
|
106
|
+
crypto-js, axios, uuid, chai, ajv, papaparse, fast-xml-parser, tough-cookie
|
|
107
|
+
|
|
108
|
+
**Globals**
|
|
109
|
+
btoa(str) / atob(str) — Base64 encode / decode
|
|
110
|
+
|
|
111
|
+
## Official Documentation
|
|
112
|
+
|
|
113
|
+
- Getting Started: https://docs.thunderclient.com
|
|
114
|
+
- CLI Reference: https://docs.thunderclient.com/cli
|
|
115
|
+
- Scripting API: https://docs.thunderclient.com/scripting
|
|
116
|
+
- Environments: https://docs.thunderclient.com/environments
|
|
117
|
+
- Tests: https://docs.thunderclient.com/tests
|
|
118
|
+
- Auth: https://docs.thunderclient.com/auth
|
|
119
|
+
`;
|
|
120
|
+
const TC_ENV_GUIDE = `# Thunder Client — Environments and Variables
|
|
121
|
+
|
|
122
|
+
## Environment Files
|
|
123
|
+
|
|
124
|
+
Thunder Client environment files may contain sensitive values such as tokens, passwords,
|
|
125
|
+
and API keys. The MCP server never reads or writes environment files. Only variable name
|
|
126
|
+
placeholders in the form {{varName}} are used in requests — the user manages actual values
|
|
127
|
+
in the Thunder Client UI.
|
|
128
|
+
|
|
129
|
+
## Using Variables in Requests
|
|
130
|
+
|
|
131
|
+
Use {{varName}} syntax wherever a dynamic value is needed — in URLs, headers, body, or auth fields.
|
|
132
|
+
Thunder Client substitutes the value from the active environment at runtime.
|
|
133
|
+
|
|
134
|
+
Whenever you set a {{varName}} placeholder, inform the user which variable needs to be defined:
|
|
135
|
+
"I have used {{accessToken}} in this request. Please add 'accessToken' to your active
|
|
136
|
+
Thunder Client environment."
|
|
137
|
+
|
|
138
|
+
## How tc.setVar Works
|
|
139
|
+
|
|
140
|
+
tc.setVar('accessToken', tc.response.json.token) saves a value to the active environment
|
|
141
|
+
after a request runs. The variable persists and can be referenced as {{accessToken}} in
|
|
142
|
+
subsequent requests. An active environment must exist for tc.setVar to have a target.
|
|
143
|
+
|
|
144
|
+
## Setting Up an Environment (guide for users)
|
|
145
|
+
|
|
146
|
+
1. Open Thunder Client → Environments panel
|
|
147
|
+
2. Click "New Environment" or select an existing one
|
|
148
|
+
3. Click the star icon to mark it as the active environment
|
|
149
|
+
4. Add the required variable name (the value can be empty initially)
|
|
150
|
+
5. Run the login or token request — the postReq script will populate the value automatically
|
|
151
|
+
6. {{varName}} will now resolve in all subsequent requests
|
|
152
|
+
|
|
153
|
+
## Unsupported Operations
|
|
154
|
+
|
|
155
|
+
If an operation is not supported by the available MCP tools, inform the user clearly and
|
|
156
|
+
direct them to perform it in the Thunder Client UI. Do not attempt to work around tool
|
|
157
|
+
limitations by editing files directly.
|
|
158
|
+
`;
|
|
159
|
+
const resources = [
|
|
160
|
+
{
|
|
161
|
+
uri: "tc://docs",
|
|
162
|
+
name: "Thunder Client Documentation",
|
|
163
|
+
description: "Thunder Client overview, tool reference, URL conventions, token flow pattern, and scripting API quick reference.",
|
|
164
|
+
mimeType: "text/markdown",
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
uri: "tc://env-guide",
|
|
168
|
+
name: "Environment Variables Guide",
|
|
169
|
+
description: "How to handle environment variables, tokens, and secrets in Thunder Client. Covers {{varName}} usage, tc.setVar behaviour, and user setup steps.",
|
|
170
|
+
mimeType: "text/markdown",
|
|
171
|
+
},
|
|
172
|
+
];
|
|
173
|
+
export function registerResources(server) {
|
|
174
|
+
server.setRequestHandler(ListResourcesRequestSchema, async () => ({
|
|
175
|
+
resources,
|
|
176
|
+
}));
|
|
177
|
+
server.setRequestHandler(ReadResourceRequestSchema, async (request) => {
|
|
178
|
+
const { uri } = request.params;
|
|
179
|
+
if (uri === "tc://docs") {
|
|
180
|
+
return {
|
|
181
|
+
contents: [{ uri, mimeType: "text/markdown", text: TC_DOCS }],
|
|
182
|
+
};
|
|
183
|
+
}
|
|
184
|
+
if (uri === "tc://env-guide") {
|
|
185
|
+
return {
|
|
186
|
+
contents: [{ uri, mimeType: "text/markdown", text: TC_ENV_GUIDE }],
|
|
187
|
+
};
|
|
188
|
+
}
|
|
189
|
+
throw new Error(`Resource not found: ${uri}`);
|
|
190
|
+
});
|
|
191
|
+
}
|
package/dist/thunder-client.d.ts
CHANGED
|
@@ -1,29 +1,209 @@
|
|
|
1
1
|
export declare class ThunderClient {
|
|
2
|
-
private
|
|
2
|
+
private checkProjectDir;
|
|
3
3
|
private execCommand;
|
|
4
|
-
|
|
4
|
+
private mcpCommand;
|
|
5
|
+
private mcpCmd;
|
|
6
|
+
getList(projectDir: string, includeActivity?: boolean): Promise<{
|
|
5
7
|
success: boolean;
|
|
6
8
|
error?: string;
|
|
7
|
-
|
|
8
|
-
|
|
9
|
+
result?: any[];
|
|
10
|
+
summary?: {
|
|
11
|
+
colId: string;
|
|
12
|
+
name: string;
|
|
13
|
+
folders: number;
|
|
14
|
+
requests: number;
|
|
15
|
+
}[];
|
|
16
|
+
total?: number;
|
|
17
|
+
collections?: number;
|
|
18
|
+
folders?: number;
|
|
19
|
+
requests?: number;
|
|
20
|
+
activityRequests?: number;
|
|
9
21
|
}>;
|
|
10
|
-
|
|
22
|
+
getListById(id: string, projectDir: string): Promise<{
|
|
11
23
|
success: boolean;
|
|
12
24
|
error?: string;
|
|
13
|
-
|
|
14
|
-
|
|
25
|
+
result?: any;
|
|
26
|
+
outline?: string;
|
|
15
27
|
}>;
|
|
16
|
-
|
|
28
|
+
private buildOutline;
|
|
29
|
+
deleteRequest(reqId: string, projectDir: string): Promise<{
|
|
30
|
+
success: boolean;
|
|
31
|
+
error?: string;
|
|
32
|
+
deleted?: {
|
|
33
|
+
reqId: string;
|
|
34
|
+
reqName: string;
|
|
35
|
+
method: string;
|
|
36
|
+
url: string;
|
|
37
|
+
};
|
|
38
|
+
}>;
|
|
39
|
+
editRequest({ reqId, projectDir, name, url, method, headers, params, body, auth, tests, preReq, postReq, docs, }: {
|
|
40
|
+
reqId: string;
|
|
41
|
+
projectDir: string;
|
|
42
|
+
name?: string;
|
|
43
|
+
url?: string;
|
|
44
|
+
method?: string;
|
|
45
|
+
headers?: {
|
|
46
|
+
name: string;
|
|
47
|
+
value: string;
|
|
48
|
+
isDisabled?: boolean;
|
|
49
|
+
}[];
|
|
50
|
+
docs?: string[];
|
|
51
|
+
params?: {
|
|
52
|
+
name: string;
|
|
53
|
+
value: string;
|
|
54
|
+
isPath?: boolean;
|
|
55
|
+
isDisabled?: boolean;
|
|
56
|
+
}[];
|
|
57
|
+
body?: {
|
|
58
|
+
type: string;
|
|
59
|
+
raw?: string;
|
|
60
|
+
form?: {
|
|
61
|
+
name: string;
|
|
62
|
+
value: string;
|
|
63
|
+
}[];
|
|
64
|
+
};
|
|
65
|
+
auth?: Record<string, any>;
|
|
66
|
+
tests?: Record<string, any>[];
|
|
67
|
+
preReq?: {
|
|
68
|
+
inlineScripts?: string[];
|
|
69
|
+
};
|
|
70
|
+
postReq?: {
|
|
71
|
+
inlineScripts?: string[];
|
|
72
|
+
};
|
|
73
|
+
}): Promise<{
|
|
74
|
+
success: boolean;
|
|
75
|
+
error?: string;
|
|
76
|
+
reqId?: string;
|
|
77
|
+
updated?: string[];
|
|
78
|
+
}>;
|
|
79
|
+
createFolder({ projectDir, collectionName, folderName, parentFolderName, }: {
|
|
80
|
+
projectDir: string;
|
|
81
|
+
collectionName: string;
|
|
82
|
+
folderName: string;
|
|
83
|
+
parentFolderName?: string;
|
|
84
|
+
}): Promise<{
|
|
85
|
+
success: boolean;
|
|
86
|
+
error?: string;
|
|
87
|
+
folderId?: string;
|
|
88
|
+
folderName?: string;
|
|
89
|
+
collectionName?: string;
|
|
90
|
+
path?: string;
|
|
91
|
+
}>;
|
|
92
|
+
createCollection({ projectDir, collectionName, }: {
|
|
93
|
+
projectDir: string;
|
|
94
|
+
collectionName: string;
|
|
95
|
+
}): Promise<{
|
|
96
|
+
success: boolean;
|
|
97
|
+
error?: string;
|
|
98
|
+
colId?: string;
|
|
99
|
+
collectionName?: string;
|
|
100
|
+
}>;
|
|
101
|
+
setSettings({ projectDir, collectionName, folderName, newName, createIfNotExists, settings, }: {
|
|
102
|
+
projectDir: string;
|
|
103
|
+
collectionName: string;
|
|
104
|
+
folderName?: string;
|
|
105
|
+
newName?: string;
|
|
106
|
+
createIfNotExists?: boolean;
|
|
107
|
+
settings?: {
|
|
108
|
+
auth?: Record<string, any>;
|
|
109
|
+
headers?: {
|
|
110
|
+
name: string;
|
|
111
|
+
value: string;
|
|
112
|
+
isDisabled?: boolean;
|
|
113
|
+
}[];
|
|
114
|
+
tests?: Record<string, any>[];
|
|
115
|
+
envId?: string;
|
|
116
|
+
docs?: string[];
|
|
117
|
+
options?: {
|
|
118
|
+
baseUrl?: string;
|
|
119
|
+
};
|
|
120
|
+
preReq?: {
|
|
121
|
+
inlineScripts?: string[];
|
|
122
|
+
};
|
|
123
|
+
postReq?: {
|
|
124
|
+
inlineScripts?: string[];
|
|
125
|
+
};
|
|
126
|
+
runOptions?: {
|
|
127
|
+
iterations?: number;
|
|
128
|
+
delay?: number;
|
|
129
|
+
dataFilePath?: string;
|
|
130
|
+
stopOnFail?: boolean;
|
|
131
|
+
concurrent?: number;
|
|
132
|
+
runType?: string;
|
|
133
|
+
vusers?: number;
|
|
134
|
+
duration?: number;
|
|
135
|
+
perfType?: string;
|
|
136
|
+
};
|
|
137
|
+
};
|
|
138
|
+
}): Promise<{
|
|
139
|
+
success: boolean;
|
|
140
|
+
error?: string;
|
|
141
|
+
target?: string;
|
|
142
|
+
renamed?: boolean;
|
|
143
|
+
settingsApplied?: string[];
|
|
144
|
+
}>;
|
|
145
|
+
runCollection({ projectDir, collectionName, folderName, env, stopOnFail, iterations, delay, concurrent, report, }: {
|
|
146
|
+
projectDir: string;
|
|
147
|
+
collectionName: string;
|
|
148
|
+
folderName?: string;
|
|
149
|
+
env?: string;
|
|
150
|
+
stopOnFail?: boolean;
|
|
151
|
+
iterations?: number;
|
|
152
|
+
delay?: number;
|
|
153
|
+
concurrent?: number;
|
|
154
|
+
report?: string[];
|
|
155
|
+
}): Promise<{
|
|
156
|
+
success: boolean;
|
|
157
|
+
error?: string;
|
|
158
|
+
report?: any;
|
|
159
|
+
envUsed?: string;
|
|
160
|
+
summary?: any;
|
|
161
|
+
}>;
|
|
162
|
+
runDebug(projectDir: string): Promise<any>;
|
|
163
|
+
listEnvironments(projectDir: string): Promise<{
|
|
164
|
+
success: boolean;
|
|
165
|
+
error?: string;
|
|
166
|
+
environments?: {
|
|
167
|
+
name: string;
|
|
168
|
+
active: boolean;
|
|
169
|
+
}[];
|
|
170
|
+
total?: number;
|
|
171
|
+
activeEnv?: string;
|
|
172
|
+
}>;
|
|
173
|
+
runRequest({ nameOrId, projectDir, env, }: {
|
|
174
|
+
nameOrId: string;
|
|
175
|
+
projectDir: string;
|
|
176
|
+
env?: string;
|
|
177
|
+
}): Promise<{
|
|
178
|
+
success: boolean;
|
|
179
|
+
error?: string;
|
|
180
|
+
result?: string;
|
|
181
|
+
envUsed?: string;
|
|
182
|
+
}>;
|
|
183
|
+
createRequest({ curlInput, name, collection, folder, projectDir, auth, tests, preReq, postReq, docs, }: {
|
|
17
184
|
curlInput: string;
|
|
18
185
|
name?: string;
|
|
19
186
|
collection?: string;
|
|
20
187
|
folder?: string;
|
|
21
188
|
projectDir: string;
|
|
189
|
+
auth?: Record<string, any>;
|
|
190
|
+
tests?: Record<string, any>[];
|
|
191
|
+
preReq?: {
|
|
192
|
+
inlineScripts?: string[];
|
|
193
|
+
};
|
|
194
|
+
postReq?: {
|
|
195
|
+
inlineScripts?: string[];
|
|
196
|
+
};
|
|
197
|
+
docs?: string[];
|
|
22
198
|
}): Promise<{
|
|
23
199
|
success: boolean;
|
|
24
200
|
error?: string;
|
|
25
|
-
|
|
26
|
-
|
|
201
|
+
reqName?: string;
|
|
202
|
+
savedTo?: string;
|
|
203
|
+
reqId?: string;
|
|
204
|
+
limitReached?: boolean;
|
|
205
|
+
limit?: any;
|
|
206
|
+
message?: string;
|
|
27
207
|
}>;
|
|
28
208
|
}
|
|
29
209
|
//# sourceMappingURL=thunder-client.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"thunder-client.d.ts","sourceRoot":"","sources":["../src/thunder-client.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"thunder-client.d.ts","sourceRoot":"","sources":["../src/thunder-client.ts"],"names":[],"mappings":"AA2DA,qBAAa,aAAa;IAEtB,OAAO,CAAC,eAAe;YAUT,WAAW;IAwBzB,OAAO,CAAC,UAAU;YAKJ,MAAM;IAwBd,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,eAAe,UAAQ,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;QAAC,OAAO,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAuBzS,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,GAAG,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAWhI,OAAO,CAAC,YAAY;IAed,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;IAM1K,WAAW,CAAC,EACd,KAAK,EACL,UAAU,EACV,IAAI,EACJ,GAAG,EACH,MAAM,EACN,OAAO,EACP,MAAM,EACN,IAAI,EACJ,IAAI,EACJ,KAAK,EACL,MAAM,EACN,OAAO,EACP,IAAI,GACP,EAAE;QACC,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAC;YAAC,UAAU,CAAC,EAAE,OAAO,CAAA;SAAE,EAAE,CAAC;QAClE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAChB,MAAM,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,OAAO,CAAC;YAAC,UAAU,CAAC,EAAE,OAAO,CAAA;SAAE,EAAE,CAAC;QACnF,IAAI,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,GAAG,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE;gBAAE,IAAI,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE,MAAM,CAAA;aAAE,EAAE,CAAA;SAAE,CAAC;QAChF,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC3B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;QAC9B,MAAM,CAAC,EAAE;YAAE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC;QACtC,OAAO,CAAC,EAAE;YAAE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC;KAC1C,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAc/E,YAAY,CAAC,EACf,UAAU,EACV,cAAc,EACd,UAAU,EACV,gBAAgB,GACnB,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,EAAE,MAAM,CAAC;QACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC7B,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAW3H,gBAAgB,CAAC,EACnB,UAAU,EACV,cAAc,GACjB,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,EAAE,MAAM,CAAC;KAC1B,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAUpF,WAAW,CAAC,EACd,UAAU,EACV,cAAc,EACd,UAAU,EACV,OAAO,EACP,iBAAiB,EACjB,QAAQ,GACX,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAC5B,QAAQ,CAAC,EAAE;YACP,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC3B,OAAO,CAAC,EAAE;gBAAE,IAAI,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE,MAAM,CAAC;gBAAC,UAAU,CAAC,EAAE,OAAO,CAAA;aAAE,EAAE,CAAC;YAClE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;YAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;YAChB,OAAO,CAAC,EAAE;gBAAE,OAAO,CAAC,EAAE,MAAM,CAAA;aAAE,CAAC;YAC/B,MAAM,CAAC,EAAE;gBAAE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;aAAE,CAAC;YACtC,OAAO,CAAC,EAAE;gBAAE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;aAAE,CAAC;YACvC,UAAU,CAAC,EAAE;gBACT,UAAU,CAAC,EAAE,MAAM,CAAC;gBACpB,KAAK,CAAC,EAAE,MAAM,CAAC;gBACf,YAAY,CAAC,EAAE,MAAM,CAAC;gBACtB,UAAU,CAAC,EAAE,OAAO,CAAC;gBACrB,UAAU,CAAC,EAAE,MAAM,CAAC;gBACpB,OAAO,CAAC,EAAE,MAAM,CAAC;gBACjB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;aACrB,CAAC;SACL,CAAC;KACL,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAc3G,aAAa,CAAC,EAChB,UAAU,EACV,cAAc,EACd,UAAU,EACV,GAAG,EACH,UAAU,EACV,UAAU,EACV,KAAK,EACL,UAAU,EACV,MAAM,GACT,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,GAAG,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,GAAG,CAAA;KAAE,CAAC;IAuC1F,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAgD1C,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,OAAO,CAAA;SAAE,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAgB3K,UAAU,CAAC,EACb,QAAQ,EACR,UAAU,EACV,GAAG,GACN,EAAE;QACC,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,GAAG,CAAC,EAAE,MAAM,CAAC;KAChB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IA0B9E,aAAa,CAAC,EAChB,SAAS,EACT,IAAI,EACJ,UAAU,EACV,MAAM,EACN,UAAU,EACV,IAAI,EACJ,KAAK,EACL,MAAM,EACN,OAAO,EACP,IAAI,GACP,EAAE;QACC,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC3B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;QAC9B,MAAM,CAAC,EAAE;YAAE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC;QACtC,OAAO,CAAC,EAAE;YAAE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC;QACvC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CA2B/J"}
|