@checkview/mcp-server 1.1.0
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/LICENSE +21 -0
- package/README.md +50 -0
- package/dist/api-client.d.ts +44 -0
- package/dist/api-client.d.ts.map +1 -0
- package/dist/api-client.js +164 -0
- package/dist/api-client.js.map +1 -0
- package/dist/format.d.ts +35 -0
- package/dist/format.d.ts.map +1 -0
- package/dist/format.js +57 -0
- package/dist/format.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +142 -0
- package/dist/index.js.map +1 -0
- package/dist/polling.d.ts +13 -0
- package/dist/polling.d.ts.map +1 -0
- package/dist/polling.js +55 -0
- package/dist/polling.js.map +1 -0
- package/dist/tools/abort-test.d.ts +4 -0
- package/dist/tools/abort-test.d.ts.map +1 -0
- package/dist/tools/abort-test.js +136 -0
- package/dist/tools/abort-test.js.map +1 -0
- package/dist/tools/add-test-comment.d.ts +4 -0
- package/dist/tools/add-test-comment.d.ts.map +1 -0
- package/dist/tools/add-test-comment.js +77 -0
- package/dist/tools/add-test-comment.js.map +1 -0
- package/dist/tools/add-website.d.ts +4 -0
- package/dist/tools/add-website.d.ts.map +1 -0
- package/dist/tools/add-website.js +106 -0
- package/dist/tools/add-website.js.map +1 -0
- package/dist/tools/check-website-availability.d.ts +4 -0
- package/dist/tools/check-website-availability.d.ts.map +1 -0
- package/dist/tools/check-website-availability.js +45 -0
- package/dist/tools/check-website-availability.js.map +1 -0
- package/dist/tools/check-website-health.d.ts +4 -0
- package/dist/tools/check-website-health.d.ts.map +1 -0
- package/dist/tools/check-website-health.js +61 -0
- package/dist/tools/check-website-health.js.map +1 -0
- package/dist/tools/compare-test-runs.d.ts +4 -0
- package/dist/tools/compare-test-runs.d.ts.map +1 -0
- package/dist/tools/compare-test-runs.js +75 -0
- package/dist/tools/compare-test-runs.js.map +1 -0
- package/dist/tools/create-form-test-flow.d.ts +4 -0
- package/dist/tools/create-form-test-flow.d.ts.map +1 -0
- package/dist/tools/create-form-test-flow.js +228 -0
- package/dist/tools/create-form-test-flow.js.map +1 -0
- package/dist/tools/create-test-flow.d.ts +4 -0
- package/dist/tools/create-test-flow.d.ts.map +1 -0
- package/dist/tools/create-test-flow.js +536 -0
- package/dist/tools/create-test-flow.js.map +1 -0
- package/dist/tools/delete-invitation.d.ts +4 -0
- package/dist/tools/delete-invitation.d.ts.map +1 -0
- package/dist/tools/delete-invitation.js +67 -0
- package/dist/tools/delete-invitation.js.map +1 -0
- package/dist/tools/delete-test-comment.d.ts +4 -0
- package/dist/tools/delete-test-comment.d.ts.map +1 -0
- package/dist/tools/delete-test-comment.js +67 -0
- package/dist/tools/delete-test-comment.js.map +1 -0
- package/dist/tools/get-ai-summary.d.ts +4 -0
- package/dist/tools/get-ai-summary.d.ts.map +1 -0
- package/dist/tools/get-ai-summary.js +61 -0
- package/dist/tools/get-ai-summary.js.map +1 -0
- package/dist/tools/get-current-organization.d.ts +4 -0
- package/dist/tools/get-current-organization.d.ts.map +1 -0
- package/dist/tools/get-current-organization.js +41 -0
- package/dist/tools/get-current-organization.js.map +1 -0
- package/dist/tools/get-generation-status.d.ts +4 -0
- package/dist/tools/get-generation-status.d.ts.map +1 -0
- package/dist/tools/get-generation-status.js +45 -0
- package/dist/tools/get-generation-status.js.map +1 -0
- package/dist/tools/get-metrics.d.ts +4 -0
- package/dist/tools/get-metrics.d.ts.map +1 -0
- package/dist/tools/get-metrics.js +90 -0
- package/dist/tools/get-metrics.js.map +1 -0
- package/dist/tools/get-organization-stats.d.ts +4 -0
- package/dist/tools/get-organization-stats.d.ts.map +1 -0
- package/dist/tools/get-organization-stats.js +53 -0
- package/dist/tools/get-organization-stats.js.map +1 -0
- package/dist/tools/get-organization.d.ts +4 -0
- package/dist/tools/get-organization.d.ts.map +1 -0
- package/dist/tools/get-organization.js +71 -0
- package/dist/tools/get-organization.js.map +1 -0
- package/dist/tools/get-results.d.ts +4 -0
- package/dist/tools/get-results.d.ts.map +1 -0
- package/dist/tools/get-results.js +154 -0
- package/dist/tools/get-results.js.map +1 -0
- package/dist/tools/get-settings.d.ts +4 -0
- package/dist/tools/get-settings.d.ts.map +1 -0
- package/dist/tools/get-settings.js +100 -0
- package/dist/tools/get-settings.js.map +1 -0
- package/dist/tools/get-step-screenshot.d.ts +4 -0
- package/dist/tools/get-step-screenshot.d.ts.map +1 -0
- package/dist/tools/get-step-screenshot.js +47 -0
- package/dist/tools/get-step-screenshot.js.map +1 -0
- package/dist/tools/get-test-flow.d.ts +4 -0
- package/dist/tools/get-test-flow.d.ts.map +1 -0
- package/dist/tools/get-test-flow.js +90 -0
- package/dist/tools/get-test-flow.js.map +1 -0
- package/dist/tools/get-test-history.d.ts +4 -0
- package/dist/tools/get-test-history.d.ts.map +1 -0
- package/dist/tools/get-test-history.js +100 -0
- package/dist/tools/get-test-history.js.map +1 -0
- package/dist/tools/get-test-run-video.d.ts +4 -0
- package/dist/tools/get-test-run-video.d.ts.map +1 -0
- package/dist/tools/get-test-run-video.js +66 -0
- package/dist/tools/get-test-run-video.js.map +1 -0
- package/dist/tools/get-test-step-details.d.ts +4 -0
- package/dist/tools/get-test-step-details.d.ts.map +1 -0
- package/dist/tools/get-test-step-details.js +166 -0
- package/dist/tools/get-test-step-details.js.map +1 -0
- package/dist/tools/get-usage-reports.d.ts +4 -0
- package/dist/tools/get-usage-reports.d.ts.map +1 -0
- package/dist/tools/get-usage-reports.js +73 -0
- package/dist/tools/get-usage-reports.js.map +1 -0
- package/dist/tools/get-usage.d.ts +4 -0
- package/dist/tools/get-usage.d.ts.map +1 -0
- package/dist/tools/get-usage.js +32 -0
- package/dist/tools/get-usage.js.map +1 -0
- package/dist/tools/get-ux-audit-report.d.ts +4 -0
- package/dist/tools/get-ux-audit-report.d.ts.map +1 -0
- package/dist/tools/get-ux-audit-report.js +52 -0
- package/dist/tools/get-ux-audit-report.js.map +1 -0
- package/dist/tools/get-website-analytics.d.ts +4 -0
- package/dist/tools/get-website-analytics.d.ts.map +1 -0
- package/dist/tools/get-website-analytics.js +54 -0
- package/dist/tools/get-website-analytics.js.map +1 -0
- package/dist/tools/get-website-logs.d.ts +4 -0
- package/dist/tools/get-website-logs.d.ts.map +1 -0
- package/dist/tools/get-website-logs.js +53 -0
- package/dist/tools/get-website-logs.js.map +1 -0
- package/dist/tools/get-website-screenshot.d.ts +4 -0
- package/dist/tools/get-website-screenshot.d.ts.map +1 -0
- package/dist/tools/get-website-screenshot.js +59 -0
- package/dist/tools/get-website-screenshot.js.map +1 -0
- package/dist/tools/get-website-settings.d.ts +4 -0
- package/dist/tools/get-website-settings.d.ts.map +1 -0
- package/dist/tools/get-website-settings.js +97 -0
- package/dist/tools/get-website-settings.js.map +1 -0
- package/dist/tools/get-website.d.ts +4 -0
- package/dist/tools/get-website.d.ts.map +1 -0
- package/dist/tools/get-website.js +45 -0
- package/dist/tools/get-website.js.map +1 -0
- package/dist/tools/invite-team-member.d.ts +4 -0
- package/dist/tools/invite-team-member.d.ts.map +1 -0
- package/dist/tools/invite-team-member.js +100 -0
- package/dist/tools/invite-team-member.js.map +1 -0
- package/dist/tools/list-forms.d.ts +4 -0
- package/dist/tools/list-forms.d.ts.map +1 -0
- package/dist/tools/list-forms.js +65 -0
- package/dist/tools/list-forms.js.map +1 -0
- package/dist/tools/list-organizations.d.ts +4 -0
- package/dist/tools/list-organizations.d.ts.map +1 -0
- package/dist/tools/list-organizations.js +78 -0
- package/dist/tools/list-organizations.js.map +1 -0
- package/dist/tools/list-team-members.d.ts +4 -0
- package/dist/tools/list-team-members.d.ts.map +1 -0
- package/dist/tools/list-team-members.js +58 -0
- package/dist/tools/list-team-members.js.map +1 -0
- package/dist/tools/list-test-comments.d.ts +4 -0
- package/dist/tools/list-test-comments.d.ts.map +1 -0
- package/dist/tools/list-test-comments.js +55 -0
- package/dist/tools/list-test-comments.js.map +1 -0
- package/dist/tools/list-test-flow-steps.d.ts +4 -0
- package/dist/tools/list-test-flow-steps.d.ts.map +1 -0
- package/dist/tools/list-test-flow-steps.js +59 -0
- package/dist/tools/list-test-flow-steps.js.map +1 -0
- package/dist/tools/list-test-flows.d.ts +4 -0
- package/dist/tools/list-test-flows.d.ts.map +1 -0
- package/dist/tools/list-test-flows.js +90 -0
- package/dist/tools/list-test-flows.js.map +1 -0
- package/dist/tools/list-test-runs.d.ts +4 -0
- package/dist/tools/list-test-runs.d.ts.map +1 -0
- package/dist/tools/list-test-runs.js +94 -0
- package/dist/tools/list-test-runs.js.map +1 -0
- package/dist/tools/list-ux-audits.d.ts +4 -0
- package/dist/tools/list-ux-audits.d.ts.map +1 -0
- package/dist/tools/list-ux-audits.js +59 -0
- package/dist/tools/list-ux-audits.js.map +1 -0
- package/dist/tools/list-websites.d.ts +4 -0
- package/dist/tools/list-websites.d.ts.map +1 -0
- package/dist/tools/list-websites.js +80 -0
- package/dist/tools/list-websites.js.map +1 -0
- package/dist/tools/manage-notification-settings.d.ts +4 -0
- package/dist/tools/manage-notification-settings.d.ts.map +1 -0
- package/dist/tools/manage-notification-settings.js +311 -0
- package/dist/tools/manage-notification-settings.js.map +1 -0
- package/dist/tools/pause-website.d.ts +4 -0
- package/dist/tools/pause-website.d.ts.map +1 -0
- package/dist/tools/pause-website.js +58 -0
- package/dist/tools/pause-website.js.map +1 -0
- package/dist/tools/regenerate-test-steps.d.ts +4 -0
- package/dist/tools/regenerate-test-steps.d.ts.map +1 -0
- package/dist/tools/regenerate-test-steps.js +173 -0
- package/dist/tools/regenerate-test-steps.js.map +1 -0
- package/dist/tools/reinitialize-test-flow.d.ts +4 -0
- package/dist/tools/reinitialize-test-flow.d.ts.map +1 -0
- package/dist/tools/reinitialize-test-flow.js +79 -0
- package/dist/tools/reinitialize-test-flow.js.map +1 -0
- package/dist/tools/remove-team-member.d.ts +4 -0
- package/dist/tools/remove-team-member.d.ts.map +1 -0
- package/dist/tools/remove-team-member.js +68 -0
- package/dist/tools/remove-team-member.js.map +1 -0
- package/dist/tools/remove-test-flow.d.ts +4 -0
- package/dist/tools/remove-test-flow.d.ts.map +1 -0
- package/dist/tools/remove-test-flow.js +74 -0
- package/dist/tools/remove-test-flow.js.map +1 -0
- package/dist/tools/remove-website.d.ts +4 -0
- package/dist/tools/remove-website.d.ts.map +1 -0
- package/dist/tools/remove-website.js +74 -0
- package/dist/tools/remove-website.js.map +1 -0
- package/dist/tools/resume-website.d.ts +4 -0
- package/dist/tools/resume-website.d.ts.map +1 -0
- package/dist/tools/resume-website.js +58 -0
- package/dist/tools/resume-website.js.map +1 -0
- package/dist/tools/run-all-tests.d.ts +4 -0
- package/dist/tools/run-all-tests.d.ts.map +1 -0
- package/dist/tools/run-all-tests.js +165 -0
- package/dist/tools/run-all-tests.js.map +1 -0
- package/dist/tools/run-test.d.ts +4 -0
- package/dist/tools/run-test.d.ts.map +1 -0
- package/dist/tools/run-test.js +186 -0
- package/dist/tools/run-test.js.map +1 -0
- package/dist/tools/run-ux-audit.d.ts +4 -0
- package/dist/tools/run-ux-audit.d.ts.map +1 -0
- package/dist/tools/run-ux-audit.js +192 -0
- package/dist/tools/run-ux-audit.js.map +1 -0
- package/dist/tools/set-organization.d.ts +4 -0
- package/dist/tools/set-organization.d.ts.map +1 -0
- package/dist/tools/set-organization.js +129 -0
- package/dist/tools/set-organization.js.map +1 -0
- package/dist/tools/test-url.d.ts +4 -0
- package/dist/tools/test-url.d.ts.map +1 -0
- package/dist/tools/test-url.js +334 -0
- package/dist/tools/test-url.js.map +1 -0
- package/dist/tools/update-organization.d.ts +4 -0
- package/dist/tools/update-organization.d.ts.map +1 -0
- package/dist/tools/update-organization.js +90 -0
- package/dist/tools/update-organization.js.map +1 -0
- package/dist/tools/update-schedule.d.ts +4 -0
- package/dist/tools/update-schedule.d.ts.map +1 -0
- package/dist/tools/update-schedule.js +157 -0
- package/dist/tools/update-schedule.js.map +1 -0
- package/dist/tools/update-settings.d.ts +4 -0
- package/dist/tools/update-settings.d.ts.map +1 -0
- package/dist/tools/update-settings.js +97 -0
- package/dist/tools/update-settings.js.map +1 -0
- package/dist/tools/update-team-member.d.ts +4 -0
- package/dist/tools/update-team-member.d.ts.map +1 -0
- package/dist/tools/update-team-member.js +102 -0
- package/dist/tools/update-team-member.js.map +1 -0
- package/dist/tools/update-test-flow-steps.d.ts +4 -0
- package/dist/tools/update-test-flow-steps.d.ts.map +1 -0
- package/dist/tools/update-test-flow-steps.js +440 -0
- package/dist/tools/update-test-flow-steps.js.map +1 -0
- package/dist/tools/update-test-flow.d.ts +4 -0
- package/dist/tools/update-test-flow.d.ts.map +1 -0
- package/dist/tools/update-test-flow.js +172 -0
- package/dist/tools/update-test-flow.js.map +1 -0
- package/dist/tools/update-website.d.ts +4 -0
- package/dist/tools/update-website.d.ts.map +1 -0
- package/dist/tools/update-website.js +86 -0
- package/dist/tools/update-website.js.map +1 -0
- package/package.json +57 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 CheckView
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# CheckView MCP Server
|
|
2
|
+
|
|
3
|
+
Manage your CheckView form and WooCommerce checkout tests from AI assistants
|
|
4
|
+
like Claude Code and Cursor.
|
|
5
|
+
|
|
6
|
+
## Quick start
|
|
7
|
+
|
|
8
|
+
No install needed. Run it with `npx`:
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
claude mcp add checkview \
|
|
12
|
+
--env CHECKVIEW_API_URL=https://api.checkview.io/api/v1 \
|
|
13
|
+
--env CHECKVIEW_API_KEY=cvpat_YOUR_TOKEN \
|
|
14
|
+
-- npx -y @checkview/mcp-server
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Or add it to any MCP client config:
|
|
18
|
+
|
|
19
|
+
```json
|
|
20
|
+
{
|
|
21
|
+
"mcpServers": {
|
|
22
|
+
"checkview": {
|
|
23
|
+
"command": "npx",
|
|
24
|
+
"args": ["-y", "@checkview/mcp-server"],
|
|
25
|
+
"env": {
|
|
26
|
+
"CHECKVIEW_API_URL": "https://api.checkview.io/api/v1",
|
|
27
|
+
"CHECKVIEW_API_KEY": "cvpat_YOUR_TOKEN"
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Authentication
|
|
35
|
+
|
|
36
|
+
Create a Personal Access Token in the CheckView dashboard under
|
|
37
|
+
**Settings → API Tokens**, and use it as `CHECKVIEW_API_KEY`.
|
|
38
|
+
|
|
39
|
+
| Variable | Required | Value |
|
|
40
|
+
| --- | --- | --- |
|
|
41
|
+
| `CHECKVIEW_API_KEY` | yes | Your `cvpat_…` token |
|
|
42
|
+
| `CHECKVIEW_API_URL` | yes | `https://api.checkview.io/api/v1` |
|
|
43
|
+
|
|
44
|
+
## What you can do
|
|
45
|
+
|
|
46
|
+
Create and run test flows, fetch results and AI failure summaries, manage
|
|
47
|
+
websites and team members, generate UX audit reports, check usage, and more,
|
|
48
|
+
all in natural language from your editor.
|
|
49
|
+
|
|
50
|
+
Requires Node.js 18+.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
export declare class ApiError extends Error {
|
|
2
|
+
status: number;
|
|
3
|
+
type?: string;
|
|
4
|
+
detail: string;
|
|
5
|
+
isReplay: boolean;
|
|
6
|
+
constructor(status: number, detail: string, type?: string, isReplay?: boolean);
|
|
7
|
+
}
|
|
8
|
+
export declare class ApiClient {
|
|
9
|
+
private baseUrl;
|
|
10
|
+
private apiKey;
|
|
11
|
+
private organizationOverride;
|
|
12
|
+
constructor(baseUrl: string, apiKey: string);
|
|
13
|
+
setOrganizationOverride(orgId: string): void;
|
|
14
|
+
clearOrganizationOverride(): void;
|
|
15
|
+
getOrganizationOverride(): string | null;
|
|
16
|
+
get<T = unknown>(path: string, queryParams?: Record<string, string | undefined>, signal?: AbortSignal): Promise<{
|
|
17
|
+
body: T;
|
|
18
|
+
headers: Headers;
|
|
19
|
+
}>;
|
|
20
|
+
post<T = unknown>(path: string, body?: unknown, idempotencyKey?: string, signal?: AbortSignal): Promise<{
|
|
21
|
+
body: T;
|
|
22
|
+
headers: Headers;
|
|
23
|
+
}>;
|
|
24
|
+
put<T = unknown>(path: string, body?: unknown, idempotencyKey?: string, signal?: AbortSignal): Promise<{
|
|
25
|
+
body: T;
|
|
26
|
+
headers: Headers;
|
|
27
|
+
}>;
|
|
28
|
+
patch<T = unknown>(path: string, body?: unknown, idempotencyKey?: string, signal?: AbortSignal): Promise<{
|
|
29
|
+
body: T;
|
|
30
|
+
headers: Headers;
|
|
31
|
+
}>;
|
|
32
|
+
delete<T = unknown>(path: string, idempotencyKey?: string, signal?: AbortSignal): Promise<{
|
|
33
|
+
body: T;
|
|
34
|
+
headers: Headers;
|
|
35
|
+
}>;
|
|
36
|
+
private defaultHeaders;
|
|
37
|
+
private buildUrl;
|
|
38
|
+
private parseError;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Generate a stable SHA-256 idempotency key from input data.
|
|
42
|
+
*/
|
|
43
|
+
export declare function idempotencyKey(input: string): string;
|
|
44
|
+
//# sourceMappingURL=api-client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-client.d.ts","sourceRoot":"","sources":["../src/api-client.ts"],"names":[],"mappings":"AAEA,qBAAa,QAAS,SAAQ,KAAK;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;gBAEN,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,UAAQ;CAQ5E;AAED,qBAAa,SAAS;IACpB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,oBAAoB,CAAuB;gBAEvC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAK3C,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI5C,yBAAyB,IAAI,IAAI;IAIjC,uBAAuB,IAAI,MAAM,GAAG,IAAI;IAIlC,GAAG,CAAC,CAAC,GAAG,OAAO,EACnB,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,EAChD,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC;QAAE,IAAI,EAAE,CAAC,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAgBnC,IAAI,CAAC,CAAC,GAAG,OAAO,EACpB,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,EACd,cAAc,CAAC,EAAE,MAAM,EACvB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC;QAAE,IAAI,EAAE,CAAC,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IA0BnC,GAAG,CAAC,CAAC,GAAG,OAAO,EACnB,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,EACd,cAAc,CAAC,EAAE,MAAM,EACvB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC;QAAE,IAAI,EAAE,CAAC,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAyBnC,KAAK,CAAC,CAAC,GAAG,OAAO,EACrB,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,EACd,cAAc,CAAC,EAAE,MAAM,EACvB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC;QAAE,IAAI,EAAE,CAAC,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAyBnC,MAAM,CAAC,CAAC,GAAG,OAAO,EACtB,IAAI,EAAE,MAAM,EACZ,cAAc,CAAC,EAAE,MAAM,EACvB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC;QAAE,IAAI,EAAE,CAAC,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAwBzC,OAAO,CAAC,cAAc;IAWtB,OAAO,CAAC,QAAQ;YAeF,UAAU;CAmBzB;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEpD"}
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
import { createHash } from "node:crypto";
|
|
2
|
+
export class ApiError extends Error {
|
|
3
|
+
status;
|
|
4
|
+
type;
|
|
5
|
+
detail;
|
|
6
|
+
isReplay;
|
|
7
|
+
constructor(status, detail, type, isReplay = false) {
|
|
8
|
+
super(detail);
|
|
9
|
+
this.name = "ApiError";
|
|
10
|
+
this.status = status;
|
|
11
|
+
this.type = type;
|
|
12
|
+
this.detail = detail;
|
|
13
|
+
this.isReplay = isReplay;
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
export class ApiClient {
|
|
17
|
+
baseUrl;
|
|
18
|
+
apiKey;
|
|
19
|
+
organizationOverride = null;
|
|
20
|
+
constructor(baseUrl, apiKey) {
|
|
21
|
+
this.baseUrl = baseUrl.replace(/\/+$/, "");
|
|
22
|
+
this.apiKey = apiKey;
|
|
23
|
+
}
|
|
24
|
+
setOrganizationOverride(orgId) {
|
|
25
|
+
this.organizationOverride = orgId;
|
|
26
|
+
}
|
|
27
|
+
clearOrganizationOverride() {
|
|
28
|
+
this.organizationOverride = null;
|
|
29
|
+
}
|
|
30
|
+
getOrganizationOverride() {
|
|
31
|
+
return this.organizationOverride;
|
|
32
|
+
}
|
|
33
|
+
async get(path, queryParams, signal) {
|
|
34
|
+
const url = this.buildUrl(path, queryParams);
|
|
35
|
+
const response = await fetch(url, {
|
|
36
|
+
method: "GET",
|
|
37
|
+
headers: this.defaultHeaders(),
|
|
38
|
+
signal,
|
|
39
|
+
});
|
|
40
|
+
if (!response.ok) {
|
|
41
|
+
throw await this.parseError(response);
|
|
42
|
+
}
|
|
43
|
+
const body = (await response.json());
|
|
44
|
+
return { body, headers: response.headers };
|
|
45
|
+
}
|
|
46
|
+
async post(path, body, idempotencyKey, signal) {
|
|
47
|
+
const headers = this.defaultHeaders();
|
|
48
|
+
if (idempotencyKey) {
|
|
49
|
+
headers["Idempotency-Key"] = idempotencyKey;
|
|
50
|
+
}
|
|
51
|
+
const response = await fetch(`${this.baseUrl}${path}`, {
|
|
52
|
+
method: "POST",
|
|
53
|
+
headers,
|
|
54
|
+
body: body !== undefined ? JSON.stringify(body) : undefined,
|
|
55
|
+
signal,
|
|
56
|
+
});
|
|
57
|
+
if (!response.ok) {
|
|
58
|
+
throw await this.parseError(response);
|
|
59
|
+
}
|
|
60
|
+
// Some endpoints return 204 No Content
|
|
61
|
+
if (response.status === 204) {
|
|
62
|
+
return { body: undefined, headers: response.headers };
|
|
63
|
+
}
|
|
64
|
+
const responseBody = (await response.json());
|
|
65
|
+
return { body: responseBody, headers: response.headers };
|
|
66
|
+
}
|
|
67
|
+
async put(path, body, idempotencyKey, signal) {
|
|
68
|
+
const headers = this.defaultHeaders();
|
|
69
|
+
if (idempotencyKey) {
|
|
70
|
+
headers["Idempotency-Key"] = idempotencyKey;
|
|
71
|
+
}
|
|
72
|
+
const response = await fetch(`${this.baseUrl}${path}`, {
|
|
73
|
+
method: "PUT",
|
|
74
|
+
headers,
|
|
75
|
+
body: body !== undefined ? JSON.stringify(body) : undefined,
|
|
76
|
+
signal,
|
|
77
|
+
});
|
|
78
|
+
if (!response.ok) {
|
|
79
|
+
throw await this.parseError(response);
|
|
80
|
+
}
|
|
81
|
+
if (response.status === 204) {
|
|
82
|
+
return { body: undefined, headers: response.headers };
|
|
83
|
+
}
|
|
84
|
+
const responseBody = (await response.json());
|
|
85
|
+
return { body: responseBody, headers: response.headers };
|
|
86
|
+
}
|
|
87
|
+
async patch(path, body, idempotencyKey, signal) {
|
|
88
|
+
const headers = this.defaultHeaders();
|
|
89
|
+
if (idempotencyKey) {
|
|
90
|
+
headers["Idempotency-Key"] = idempotencyKey;
|
|
91
|
+
}
|
|
92
|
+
const response = await fetch(`${this.baseUrl}${path}`, {
|
|
93
|
+
method: "PATCH",
|
|
94
|
+
headers,
|
|
95
|
+
body: body !== undefined ? JSON.stringify(body) : undefined,
|
|
96
|
+
signal,
|
|
97
|
+
});
|
|
98
|
+
if (!response.ok) {
|
|
99
|
+
throw await this.parseError(response);
|
|
100
|
+
}
|
|
101
|
+
if (response.status === 204) {
|
|
102
|
+
return { body: undefined, headers: response.headers };
|
|
103
|
+
}
|
|
104
|
+
const responseBody = (await response.json());
|
|
105
|
+
return { body: responseBody, headers: response.headers };
|
|
106
|
+
}
|
|
107
|
+
async delete(path, idempotencyKey, signal) {
|
|
108
|
+
const headers = this.defaultHeaders();
|
|
109
|
+
if (idempotencyKey) {
|
|
110
|
+
headers["Idempotency-Key"] = idempotencyKey;
|
|
111
|
+
}
|
|
112
|
+
const response = await fetch(`${this.baseUrl}${path}`, {
|
|
113
|
+
method: "DELETE",
|
|
114
|
+
headers,
|
|
115
|
+
signal,
|
|
116
|
+
});
|
|
117
|
+
if (!response.ok) {
|
|
118
|
+
throw await this.parseError(response);
|
|
119
|
+
}
|
|
120
|
+
if (response.status === 204) {
|
|
121
|
+
return { body: undefined, headers: response.headers };
|
|
122
|
+
}
|
|
123
|
+
const responseBody = (await response.json());
|
|
124
|
+
return { body: responseBody, headers: response.headers };
|
|
125
|
+
}
|
|
126
|
+
defaultHeaders() {
|
|
127
|
+
const headers = {
|
|
128
|
+
Authorization: `Bearer ${this.apiKey}`,
|
|
129
|
+
"Content-Type": "application/json",
|
|
130
|
+
};
|
|
131
|
+
if (this.organizationOverride) {
|
|
132
|
+
headers["X-Tenant"] = this.organizationOverride;
|
|
133
|
+
}
|
|
134
|
+
return headers;
|
|
135
|
+
}
|
|
136
|
+
buildUrl(path, queryParams) {
|
|
137
|
+
const url = new URL(`${this.baseUrl}${path}`);
|
|
138
|
+
if (queryParams) {
|
|
139
|
+
for (const [key, value] of Object.entries(queryParams)) {
|
|
140
|
+
if (value !== undefined && value !== null) {
|
|
141
|
+
url.searchParams.set(key, value);
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
return url.toString();
|
|
146
|
+
}
|
|
147
|
+
async parseError(response) {
|
|
148
|
+
const isReplay = response.headers.get("X-Idempotency-Replay") === "true";
|
|
149
|
+
try {
|
|
150
|
+
const body = await response.json();
|
|
151
|
+
return new ApiError(response.status, body.detail || body.message || response.statusText, body.type, isReplay);
|
|
152
|
+
}
|
|
153
|
+
catch {
|
|
154
|
+
return new ApiError(response.status, response.statusText, undefined, isReplay);
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* Generate a stable SHA-256 idempotency key from input data.
|
|
160
|
+
*/
|
|
161
|
+
export function idempotencyKey(input) {
|
|
162
|
+
return createHash("sha256").update(input).digest("hex");
|
|
163
|
+
}
|
|
164
|
+
//# sourceMappingURL=api-client.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-client.js","sourceRoot":"","sources":["../src/api-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,MAAM,OAAO,QAAS,SAAQ,KAAK;IACjC,MAAM,CAAS;IACf,IAAI,CAAU;IACd,MAAM,CAAS;IACf,QAAQ,CAAU;IAElB,YAAY,MAAc,EAAE,MAAc,EAAE,IAAa,EAAE,QAAQ,GAAG,KAAK;QACzE,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED,MAAM,OAAO,SAAS;IACZ,OAAO,CAAS;IAChB,MAAM,CAAS;IACf,oBAAoB,GAAkB,IAAI,CAAC;IAEnD,YAAY,OAAe,EAAE,MAAc;QACzC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,uBAAuB,CAAC,KAAa;QACnC,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC;IACpC,CAAC;IAED,yBAAyB;QACvB,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;IACnC,CAAC;IAED,uBAAuB;QACrB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,GAAG,CACP,IAAY,EACZ,WAAgD,EAChD,MAAoB;QAEpB,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAChC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,IAAI,CAAC,cAAc,EAAE;YAC9B,MAAM;SACP,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACxC,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;QAC1C,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,IAAI,CACR,IAAY,EACZ,IAAc,EACd,cAAuB,EACvB,MAAoB;QAEpB,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACtC,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,iBAAiB,CAAC,GAAG,cAAc,CAAC;QAC9C,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,EAAE;YACrD,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;YAC3D,MAAM;SACP,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACxC,CAAC;QAED,uCAAuC;QACvC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,OAAO,EAAE,IAAI,EAAE,SAAc,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QAC7D,CAAC;QAED,MAAM,YAAY,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;QAClD,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,GAAG,CACP,IAAY,EACZ,IAAc,EACd,cAAuB,EACvB,MAAoB;QAEpB,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACtC,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,iBAAiB,CAAC,GAAG,cAAc,CAAC;QAC9C,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,EAAE;YACrD,MAAM,EAAE,KAAK;YACb,OAAO;YACP,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;YAC3D,MAAM;SACP,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,OAAO,EAAE,IAAI,EAAE,SAAc,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QAC7D,CAAC;QAED,MAAM,YAAY,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;QAClD,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,KAAK,CACT,IAAY,EACZ,IAAc,EACd,cAAuB,EACvB,MAAoB;QAEpB,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACtC,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,iBAAiB,CAAC,GAAG,cAAc,CAAC;QAC9C,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,EAAE;YACrD,MAAM,EAAE,OAAO;YACf,OAAO;YACP,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;YAC3D,MAAM;SACP,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,OAAO,EAAE,IAAI,EAAE,SAAc,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QAC7D,CAAC;QAED,MAAM,YAAY,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;QAClD,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAY,EACZ,cAAuB,EACvB,MAAoB;QAEpB,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACtC,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,iBAAiB,CAAC,GAAG,cAAc,CAAC;QAC9C,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,EAAE;YACrD,MAAM,EAAE,QAAQ;YAChB,OAAO;YACP,MAAM;SACP,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,OAAO,EAAE,IAAI,EAAE,SAAc,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QAC7D,CAAC;QAED,MAAM,YAAY,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;QAClD,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC3D,CAAC;IAEO,cAAc;QACpB,MAAM,OAAO,GAA2B;YACtC,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;YACtC,cAAc,EAAE,kBAAkB;SACnC,CAAC;QACF,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC9B,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QAClD,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,QAAQ,CACd,IAAY,EACZ,WAAgD;QAEhD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC,CAAC;QAC9C,IAAI,WAAW,EAAE,CAAC;YAChB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBACvD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBAC1C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,QAAkB;QACzC,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,KAAK,MAAM,CAAC;QACzE,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,OAAO,IAAI,QAAQ,CACjB,QAAQ,CAAC,MAAM,EACf,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,IAAI,QAAQ,CAAC,UAAU,EAClD,IAAI,CAAC,IAAI,EACT,QAAQ,CACT,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,QAAQ,CACjB,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,UAAU,EACnB,SAAS,EACT,QAAQ,CACT,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,KAAa;IAC1C,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1D,CAAC"}
|
package/dist/format.d.ts
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
export interface TestRunStep {
|
|
2
|
+
id: string;
|
|
3
|
+
index: number;
|
|
4
|
+
type: string;
|
|
5
|
+
status: string;
|
|
6
|
+
error_message?: string | null;
|
|
7
|
+
error_type?: string | null;
|
|
8
|
+
screenshot_url?: string | null;
|
|
9
|
+
data?: unknown;
|
|
10
|
+
[key: string]: unknown;
|
|
11
|
+
}
|
|
12
|
+
export interface TestRunDetail {
|
|
13
|
+
id: string;
|
|
14
|
+
status: string;
|
|
15
|
+
started_at?: string | null;
|
|
16
|
+
ended_at?: string | null;
|
|
17
|
+
blocker?: string | null;
|
|
18
|
+
blocker_message?: string | null;
|
|
19
|
+
website?: {
|
|
20
|
+
name: string;
|
|
21
|
+
url: string;
|
|
22
|
+
} | null;
|
|
23
|
+
test_flow?: {
|
|
24
|
+
name: string;
|
|
25
|
+
type: string;
|
|
26
|
+
} | null;
|
|
27
|
+
steps?: TestRunStep[];
|
|
28
|
+
[key: string]: unknown;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Format a test run detail into a human-readable text block.
|
|
32
|
+
* Strips infrastructure noise (job IDs, signed URLs).
|
|
33
|
+
*/
|
|
34
|
+
export declare function formatTestRun(testRun: TestRunDetail): string;
|
|
35
|
+
//# sourceMappingURL=format.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAC/C,SAAS,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAClD,KAAK,CAAC,EAAE,WAAW,EAAE,CAAC;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,MAAM,CAkE5D"}
|
package/dist/format.js
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Format a test run detail into a human-readable text block.
|
|
3
|
+
* Strips infrastructure noise (job IDs, signed URLs).
|
|
4
|
+
*/
|
|
5
|
+
export function formatTestRun(testRun) {
|
|
6
|
+
const lines = [];
|
|
7
|
+
// Header
|
|
8
|
+
const status = testRun.status ?? "unknown";
|
|
9
|
+
const statusIcon = status === "success"
|
|
10
|
+
? "PASSED"
|
|
11
|
+
: status === "error"
|
|
12
|
+
? "FAILED"
|
|
13
|
+
: status.toUpperCase();
|
|
14
|
+
lines.push(`## Test Result: ${statusIcon}`);
|
|
15
|
+
lines.push("");
|
|
16
|
+
// Context
|
|
17
|
+
if (testRun.website) {
|
|
18
|
+
lines.push(`**Website:** ${testRun.website.name} (${testRun.website.url})`);
|
|
19
|
+
}
|
|
20
|
+
if (testRun.test_flow) {
|
|
21
|
+
lines.push(`**Test Flow:** ${testRun.test_flow.name} (${testRun.test_flow.type})`);
|
|
22
|
+
}
|
|
23
|
+
lines.push(`**Test Run ID:** ${testRun.id}`);
|
|
24
|
+
// Timing
|
|
25
|
+
if (testRun.started_at && testRun.ended_at) {
|
|
26
|
+
const start = new Date(testRun.started_at);
|
|
27
|
+
const end = new Date(testRun.ended_at);
|
|
28
|
+
const durationSec = ((end.getTime() - start.getTime()) / 1000).toFixed(1);
|
|
29
|
+
lines.push(`**Duration:** ${durationSec}s`);
|
|
30
|
+
}
|
|
31
|
+
// Blocker warning
|
|
32
|
+
if (testRun.blocker) {
|
|
33
|
+
lines.push("");
|
|
34
|
+
lines.push(`**BLOCKER:** ${testRun.blocker}${testRun.blocker_message ? ` — ${testRun.blocker_message}` : ""}`);
|
|
35
|
+
}
|
|
36
|
+
// Steps
|
|
37
|
+
const steps = testRun.steps ?? [];
|
|
38
|
+
if (steps.length > 0) {
|
|
39
|
+
lines.push("");
|
|
40
|
+
lines.push(`### Steps (${steps.length} total)`);
|
|
41
|
+
lines.push("");
|
|
42
|
+
for (const step of steps) {
|
|
43
|
+
const ss = step.status ?? "unknown";
|
|
44
|
+
const stepStatus = ss === "success" ? "PASS" : ss === "error" ? "FAIL" : ss.toUpperCase();
|
|
45
|
+
let line = `${step.index}. [${stepStatus}] ${step.type}`;
|
|
46
|
+
if (step.error_message) {
|
|
47
|
+
line += ` — ${step.error_message}`;
|
|
48
|
+
}
|
|
49
|
+
if (step.error_type) {
|
|
50
|
+
line += ` (${step.error_type})`;
|
|
51
|
+
}
|
|
52
|
+
lines.push(line);
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
return lines.join("\n");
|
|
56
|
+
}
|
|
57
|
+
//# sourceMappingURL=format.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"format.js","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAyBA;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,OAAsB;IAClD,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,SAAS;IACT,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,SAAS,CAAC;IAC3C,MAAM,UAAU,GACd,MAAM,KAAK,SAAS;QAClB,CAAC,CAAC,QAAQ;QACV,CAAC,CAAC,MAAM,KAAK,OAAO;YAClB,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC7B,KAAK,CAAC,IAAI,CAAC,mBAAmB,UAAU,EAAE,CAAC,CAAC;IAC5C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,UAAU;IACV,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,KAAK,CAAC,IAAI,CAAC,gBAAgB,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC;IAC9E,CAAC;IACD,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACtB,KAAK,CAAC,IAAI,CACR,kBAAkB,OAAO,CAAC,SAAS,CAAC,IAAI,KAAK,OAAO,CAAC,SAAS,CAAC,IAAI,GAAG,CACvE,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,oBAAoB,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;IAE7C,SAAS;IACT,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QAC3C,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC3C,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,WAAW,GAAG,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC1E,KAAK,CAAC,IAAI,CAAC,iBAAiB,WAAW,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED,kBAAkB;IAClB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CACR,gBAAgB,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CACnG,CAAC;IACJ,CAAC;IAED,QAAQ;IACR,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;IAClC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,cAAc,KAAK,CAAC,MAAM,SAAS,CAAC,CAAC;QAChD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEf,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,IAAI,SAAS,CAAC;YACpC,MAAM,UAAU,GACd,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC;YACzE,IAAI,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK,MAAM,UAAU,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YAEzD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;gBACvB,IAAI,IAAI,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YACrC,CAAC;YACD,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,IAAI,IAAI,KAAK,IAAI,CAAC,UAAU,GAAG,CAAC;YAClC,CAAC;YAED,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
3
|
+
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
|
4
|
+
import { ApiClient } from "./api-client.js";
|
|
5
|
+
import { registerAbortTestTool } from "./tools/abort-test.js";
|
|
6
|
+
import { registerAddTestCommentTool } from "./tools/add-test-comment.js";
|
|
7
|
+
import { registerAddWebsiteTool } from "./tools/add-website.js";
|
|
8
|
+
import { registerCheckWebsiteAvailabilityTool } from "./tools/check-website-availability.js";
|
|
9
|
+
import { registerCheckWebsiteHealthTool } from "./tools/check-website-health.js";
|
|
10
|
+
import { registerCompareTestRunsTool } from "./tools/compare-test-runs.js";
|
|
11
|
+
import { registerCreateFormTestFlowTool } from "./tools/create-form-test-flow.js";
|
|
12
|
+
import { registerCreateTestFlowTool } from "./tools/create-test-flow.js";
|
|
13
|
+
import { registerDeleteInvitationTool } from "./tools/delete-invitation.js";
|
|
14
|
+
import { registerDeleteTestCommentTool } from "./tools/delete-test-comment.js";
|
|
15
|
+
import { registerGetAiSummaryTool } from "./tools/get-ai-summary.js";
|
|
16
|
+
import { registerGetCurrentOrganizationTool } from "./tools/get-current-organization.js";
|
|
17
|
+
import { registerGetGenerationStatusTool } from "./tools/get-generation-status.js";
|
|
18
|
+
import { registerGetMetricsTool } from "./tools/get-metrics.js";
|
|
19
|
+
import { registerGetOrganizationTool } from "./tools/get-organization.js";
|
|
20
|
+
import { registerGetOrganizationStatsTool } from "./tools/get-organization-stats.js";
|
|
21
|
+
import { registerGetResultsTool } from "./tools/get-results.js";
|
|
22
|
+
import { registerGetSettingsTool } from "./tools/get-settings.js";
|
|
23
|
+
import { registerGetStepScreenshotTool } from "./tools/get-step-screenshot.js";
|
|
24
|
+
import { registerGetTestFlowTool } from "./tools/get-test-flow.js";
|
|
25
|
+
import { registerGetTestHistoryTool } from "./tools/get-test-history.js";
|
|
26
|
+
import { registerGetTestRunVideoTool } from "./tools/get-test-run-video.js";
|
|
27
|
+
import { registerGetTestStepDetailsTool } from "./tools/get-test-step-details.js";
|
|
28
|
+
import { registerGetUsageTool } from "./tools/get-usage.js";
|
|
29
|
+
import { registerGetUsageReportsTool } from "./tools/get-usage-reports.js";
|
|
30
|
+
import { registerGetUxAuditReportTool } from "./tools/get-ux-audit-report.js";
|
|
31
|
+
import { registerGetWebsiteTool } from "./tools/get-website.js";
|
|
32
|
+
import { registerGetWebsiteAnalyticsTool } from "./tools/get-website-analytics.js";
|
|
33
|
+
import { registerGetWebsiteLogsTool } from "./tools/get-website-logs.js";
|
|
34
|
+
import { registerGetWebsiteScreenshotTool } from "./tools/get-website-screenshot.js";
|
|
35
|
+
import { registerGetWebsiteSettingsTool } from "./tools/get-website-settings.js";
|
|
36
|
+
import { registerInviteTeamMemberTool } from "./tools/invite-team-member.js";
|
|
37
|
+
import { registerListFormsTool } from "./tools/list-forms.js";
|
|
38
|
+
import { registerListOrganizationsTool } from "./tools/list-organizations.js";
|
|
39
|
+
import { registerListTeamMembersTool } from "./tools/list-team-members.js";
|
|
40
|
+
import { registerListTestCommentsTool } from "./tools/list-test-comments.js";
|
|
41
|
+
import { registerListTestFlowsTool } from "./tools/list-test-flows.js";
|
|
42
|
+
import { registerListTestFlowStepsTool } from "./tools/list-test-flow-steps.js";
|
|
43
|
+
import { registerListTestRunsTool } from "./tools/list-test-runs.js";
|
|
44
|
+
import { registerListUxAuditsTool } from "./tools/list-ux-audits.js";
|
|
45
|
+
import { registerListWebsitesTool } from "./tools/list-websites.js";
|
|
46
|
+
import { registerManageNotificationSettingsTool } from "./tools/manage-notification-settings.js";
|
|
47
|
+
import { registerPauseWebsiteTool } from "./tools/pause-website.js";
|
|
48
|
+
import { registerRegenerateTestStepsTool } from "./tools/regenerate-test-steps.js";
|
|
49
|
+
import { registerReinitializeTestFlowTool } from "./tools/reinitialize-test-flow.js";
|
|
50
|
+
import { registerRemoveTeamMemberTool } from "./tools/remove-team-member.js";
|
|
51
|
+
import { registerRemoveTestFlowTool } from "./tools/remove-test-flow.js";
|
|
52
|
+
import { registerRemoveWebsiteTool } from "./tools/remove-website.js";
|
|
53
|
+
import { registerResumeWebsiteTool } from "./tools/resume-website.js";
|
|
54
|
+
import { registerRunAllTestsTool } from "./tools/run-all-tests.js";
|
|
55
|
+
import { registerRunTestTool } from "./tools/run-test.js";
|
|
56
|
+
import { registerRunUxAuditTool } from "./tools/run-ux-audit.js";
|
|
57
|
+
import { registerSetOrganizationTool } from "./tools/set-organization.js";
|
|
58
|
+
import { registerTestUrlTool } from "./tools/test-url.js";
|
|
59
|
+
import { registerUpdateOrganizationTool } from "./tools/update-organization.js";
|
|
60
|
+
import { registerUpdateScheduleTool } from "./tools/update-schedule.js";
|
|
61
|
+
import { registerUpdateSettingsTool } from "./tools/update-settings.js";
|
|
62
|
+
import { registerUpdateTeamMemberTool } from "./tools/update-team-member.js";
|
|
63
|
+
import { registerUpdateTestFlowTool } from "./tools/update-test-flow.js";
|
|
64
|
+
import { registerUpdateTestFlowStepsTool } from "./tools/update-test-flow-steps.js";
|
|
65
|
+
import { registerUpdateWebsiteTool } from "./tools/update-website.js";
|
|
66
|
+
// Validate env vars
|
|
67
|
+
const apiUrl = process.env.CHECKVIEW_API_URL;
|
|
68
|
+
const apiKey = process.env.CHECKVIEW_API_KEY;
|
|
69
|
+
if (!apiUrl || !apiKey) {
|
|
70
|
+
process.stderr.write("Error: Missing required environment variables.\n" +
|
|
71
|
+
"Set CHECKVIEW_API_URL and CHECKVIEW_API_KEY.\n" +
|
|
72
|
+
"Example: CHECKVIEW_API_URL=https://api.checkview.io/api/v1 CHECKVIEW_API_KEY=cvpat_...\n");
|
|
73
|
+
process.exit(1);
|
|
74
|
+
}
|
|
75
|
+
const server = new McpServer({ name: "checkview", version: "1.1.0" }, { capabilities: { logging: {} } });
|
|
76
|
+
const client = new ApiClient(apiUrl, apiKey);
|
|
77
|
+
// Register all tools
|
|
78
|
+
registerAbortTestTool(server, client);
|
|
79
|
+
registerAddTestCommentTool(server, client);
|
|
80
|
+
registerAddWebsiteTool(server, client);
|
|
81
|
+
registerCheckWebsiteAvailabilityTool(server, client);
|
|
82
|
+
registerCheckWebsiteHealthTool(server, client);
|
|
83
|
+
registerCompareTestRunsTool(server, client);
|
|
84
|
+
registerCreateFormTestFlowTool(server, client);
|
|
85
|
+
registerCreateTestFlowTool(server, client);
|
|
86
|
+
registerDeleteInvitationTool(server, client);
|
|
87
|
+
registerDeleteTestCommentTool(server, client);
|
|
88
|
+
registerGetAiSummaryTool(server, client);
|
|
89
|
+
registerGetCurrentOrganizationTool(server, client);
|
|
90
|
+
registerGetGenerationStatusTool(server, client);
|
|
91
|
+
registerGetMetricsTool(server, client);
|
|
92
|
+
registerGetOrganizationTool(server, client);
|
|
93
|
+
registerGetOrganizationStatsTool(server, client);
|
|
94
|
+
registerGetResultsTool(server, client);
|
|
95
|
+
registerGetSettingsTool(server, client);
|
|
96
|
+
registerGetStepScreenshotTool(server, client);
|
|
97
|
+
registerGetTestFlowTool(server, client);
|
|
98
|
+
registerGetTestHistoryTool(server, client);
|
|
99
|
+
registerGetTestRunVideoTool(server, client);
|
|
100
|
+
registerGetTestStepDetailsTool(server, client);
|
|
101
|
+
registerGetUsageTool(server, client);
|
|
102
|
+
registerGetUsageReportsTool(server, client);
|
|
103
|
+
registerGetUxAuditReportTool(server, client);
|
|
104
|
+
registerGetWebsiteTool(server, client);
|
|
105
|
+
registerGetWebsiteAnalyticsTool(server, client);
|
|
106
|
+
registerGetWebsiteLogsTool(server, client);
|
|
107
|
+
registerGetWebsiteScreenshotTool(server, client);
|
|
108
|
+
registerGetWebsiteSettingsTool(server, client);
|
|
109
|
+
registerInviteTeamMemberTool(server, client);
|
|
110
|
+
registerListFormsTool(server, client);
|
|
111
|
+
registerListOrganizationsTool(server, client);
|
|
112
|
+
registerListTeamMembersTool(server, client);
|
|
113
|
+
registerListTestCommentsTool(server, client);
|
|
114
|
+
registerListTestFlowsTool(server, client);
|
|
115
|
+
registerListTestFlowStepsTool(server, client);
|
|
116
|
+
registerListTestRunsTool(server, client);
|
|
117
|
+
registerListUxAuditsTool(server, client);
|
|
118
|
+
registerListWebsitesTool(server, client);
|
|
119
|
+
registerManageNotificationSettingsTool(server, client);
|
|
120
|
+
registerPauseWebsiteTool(server, client);
|
|
121
|
+
registerRegenerateTestStepsTool(server, client);
|
|
122
|
+
registerReinitializeTestFlowTool(server, client);
|
|
123
|
+
registerRemoveTeamMemberTool(server, client);
|
|
124
|
+
registerRemoveTestFlowTool(server, client);
|
|
125
|
+
registerRemoveWebsiteTool(server, client);
|
|
126
|
+
registerResumeWebsiteTool(server, client);
|
|
127
|
+
registerRunAllTestsTool(server, client);
|
|
128
|
+
registerRunTestTool(server, client);
|
|
129
|
+
registerRunUxAuditTool(server, client);
|
|
130
|
+
registerSetOrganizationTool(server, client);
|
|
131
|
+
registerTestUrlTool(server, client);
|
|
132
|
+
registerUpdateOrganizationTool(server, client);
|
|
133
|
+
registerUpdateScheduleTool(server, client);
|
|
134
|
+
registerUpdateSettingsTool(server, client);
|
|
135
|
+
registerUpdateTeamMemberTool(server, client);
|
|
136
|
+
registerUpdateTestFlowTool(server, client);
|
|
137
|
+
registerUpdateTestFlowStepsTool(server, client);
|
|
138
|
+
registerUpdateWebsiteTool(server, client);
|
|
139
|
+
// Connect via stdio transport
|
|
140
|
+
const transport = new StdioServerTransport();
|
|
141
|
+
await server.connect(transport);
|
|
142
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,oCAAoC,EAAE,MAAM,uCAAuC,CAAC;AAC7F,OAAO,EAAE,8BAA8B,EAAE,MAAM,iCAAiC,CAAC;AACjF,OAAO,EAAE,2BAA2B,EAAE,MAAM,8BAA8B,CAAC;AAC3E,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAClF,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAE,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AAC5E,OAAO,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AAC/E,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,kCAAkC,EAAE,MAAM,qCAAqC,CAAC;AACzF,OAAO,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAC;AACnF,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAC;AAC1E,OAAO,EAAE,gCAAgC,EAAE,MAAM,mCAAmC,CAAC;AACrF,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AAC/E,OAAO,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAClF,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,2BAA2B,EAAE,MAAM,8BAA8B,CAAC;AAC3E,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAC9E,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAC;AACnF,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAE,gCAAgC,EAAE,MAAM,mCAAmC,CAAC;AACrF,OAAO,EAAE,8BAA8B,EAAE,MAAM,iCAAiC,CAAC;AACjF,OAAO,EAAE,4BAA4B,EAAE,MAAM,+BAA+B,CAAC;AAC7E,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,6BAA6B,EAAE,MAAM,+BAA+B,CAAC;AAC9E,OAAO,EAAE,2BAA2B,EAAE,MAAM,8BAA8B,CAAC;AAC3E,OAAO,EAAE,4BAA4B,EAAE,MAAM,+BAA+B,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,sCAAsC,EAAE,MAAM,yCAAyC,CAAC;AACjG,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAC;AACnF,OAAO,EAAE,gCAAgC,EAAE,MAAM,mCAAmC,CAAC;AACrF,OAAO,EAAE,4BAA4B,EAAE,MAAM,+BAA+B,CAAC;AAC7E,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,8BAA8B,EAAE,MAAM,gCAAgC,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,EAAE,4BAA4B,EAAE,MAAM,+BAA+B,CAAC;AAC7E,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAE,+BAA+B,EAAE,MAAM,mCAAmC,CAAC;AACpF,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAEtE,oBAAoB;AACpB,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;AAC7C,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;AAC7C,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,kDAAkD;QAChD,gDAAgD;QAChD,0FAA0F,CAC7F,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,MAAM,GAAG,IAAI,SAAS,CAC1B,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,EACvC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,CAClC,CAAC;AAEF,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAE7C,qBAAqB;AACrB,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACtC,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC3C,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACvC,oCAAoC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACrD,8BAA8B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC/C,2BAA2B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC5C,8BAA8B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC/C,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC3C,4BAA4B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC7C,6BAA6B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC9C,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACzC,kCAAkC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACnD,+BAA+B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAChD,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACvC,2BAA2B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC5C,gCAAgC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACjD,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACvC,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACxC,6BAA6B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC9C,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACxC,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC3C,2BAA2B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC5C,8BAA8B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC/C,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACrC,2BAA2B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC5C,4BAA4B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC7C,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACvC,+BAA+B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAChD,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC3C,gCAAgC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACjD,8BAA8B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC/C,4BAA4B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC7C,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACtC,6BAA6B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC9C,2BAA2B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC5C,4BAA4B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC7C,yBAAyB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC1C,6BAA6B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC9C,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACzC,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACzC,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACzC,sCAAsC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACvD,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACzC,+BAA+B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAChD,gCAAgC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACjD,4BAA4B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC7C,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC3C,yBAAyB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC1C,yBAAyB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC1C,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACxC,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACpC,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACvC,2BAA2B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC5C,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACpC,8BAA8B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC/C,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC3C,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC3C,4BAA4B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC7C,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC3C,+BAA+B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAChD,yBAAyB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAE1C,8BAA8B;AAC9B,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;AAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export interface PollOptions<T> {
|
|
2
|
+
intervalMs: number;
|
|
3
|
+
timeoutMs: number;
|
|
4
|
+
signal?: AbortSignal;
|
|
5
|
+
onProgress?: (result: T) => void;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Polls an async operation until a completion condition is met.
|
|
9
|
+
* Backs off on 429 rate-limit responses (doubles interval, max 60s).
|
|
10
|
+
* Checks abort signal before each iteration.
|
|
11
|
+
*/
|
|
12
|
+
export declare function pollUntil<T>(fetchFn: () => Promise<T>, isDone: (result: T) => boolean, options: PollOptions<T>): Promise<T>;
|
|
13
|
+
//# sourceMappingURL=polling.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"polling.d.ts","sourceRoot":"","sources":["../src/polling.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,CAAC;CAClC;AAED;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,CAAC,EAC/B,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACzB,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,OAAO,EAC9B,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,GACtB,OAAO,CAAC,CAAC,CAAC,CAoDZ"}
|
package/dist/polling.js
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { ApiError } from "./api-client.js";
|
|
2
|
+
/**
|
|
3
|
+
* Polls an async operation until a completion condition is met.
|
|
4
|
+
* Backs off on 429 rate-limit responses (doubles interval, max 60s).
|
|
5
|
+
* Checks abort signal before each iteration.
|
|
6
|
+
*/
|
|
7
|
+
export async function pollUntil(fetchFn, isDone, options) {
|
|
8
|
+
const { timeoutMs, signal, onProgress } = options;
|
|
9
|
+
let intervalMs = options.intervalMs;
|
|
10
|
+
const deadline = Date.now() + timeoutMs;
|
|
11
|
+
let lastResult;
|
|
12
|
+
while (Date.now() < deadline) {
|
|
13
|
+
if (signal?.aborted) {
|
|
14
|
+
throw new Error("Operation cancelled");
|
|
15
|
+
}
|
|
16
|
+
try {
|
|
17
|
+
lastResult = await fetchFn();
|
|
18
|
+
// Reset interval after successful response
|
|
19
|
+
intervalMs = options.intervalMs;
|
|
20
|
+
if (onProgress) {
|
|
21
|
+
onProgress(lastResult);
|
|
22
|
+
}
|
|
23
|
+
if (isDone(lastResult)) {
|
|
24
|
+
return lastResult;
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
catch (error) {
|
|
28
|
+
if (error instanceof ApiError && error.status === 429) {
|
|
29
|
+
// Rate limited — double interval (max 60s)
|
|
30
|
+
intervalMs = Math.min(intervalMs * 2, 60_000);
|
|
31
|
+
}
|
|
32
|
+
else {
|
|
33
|
+
throw error;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
// Wait before next poll, respecting abort signal
|
|
37
|
+
await new Promise((resolve, reject) => {
|
|
38
|
+
let onAbort;
|
|
39
|
+
const timer = setTimeout(() => {
|
|
40
|
+
if (onAbort && signal)
|
|
41
|
+
signal.removeEventListener("abort", onAbort);
|
|
42
|
+
resolve();
|
|
43
|
+
}, intervalMs);
|
|
44
|
+
if (signal) {
|
|
45
|
+
onAbort = () => {
|
|
46
|
+
clearTimeout(timer);
|
|
47
|
+
reject(new Error("Operation cancelled"));
|
|
48
|
+
};
|
|
49
|
+
signal.addEventListener("abort", onAbort, { once: true });
|
|
50
|
+
}
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
throw new Error(`Operation timed out after ${timeoutMs / 1000}s. Last status: ${JSON.stringify(lastResult)}`);
|
|
54
|
+
}
|
|
55
|
+
//# sourceMappingURL=polling.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"polling.js","sourceRoot":"","sources":["../src/polling.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAS3C;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,OAAyB,EACzB,MAA8B,EAC9B,OAAuB;IAEvB,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IAClD,IAAI,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;IACxC,IAAI,UAAyB,CAAC;IAE9B,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;QAC7B,IAAI,MAAM,EAAE,OAAO,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QAED,IAAI,CAAC;YACH,UAAU,GAAG,MAAM,OAAO,EAAE,CAAC;YAC7B,2CAA2C;YAC3C,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;YAEhC,IAAI,UAAU,EAAE,CAAC;gBACf,UAAU,CAAC,UAAU,CAAC,CAAC;YACzB,CAAC;YAED,IAAI,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;gBACvB,OAAO,UAAU,CAAC;YACpB,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,QAAQ,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACtD,2CAA2C;gBAC3C,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;YAChD,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;QAED,iDAAiD;QACjD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,IAAI,OAAiC,CAAC;YACtC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,IAAI,OAAO,IAAI,MAAM;oBAAE,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBACpE,OAAO,EAAE,CAAC;YACZ,CAAC,EAAE,UAAU,CAAC,CAAC;YACf,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO,GAAG,GAAG,EAAE;oBACb,YAAY,CAAC,KAAK,CAAC,CAAC;oBACpB,MAAM,CAAC,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC;gBAC3C,CAAC,CAAC;gBACF,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,IAAI,KAAK,CACb,6BAA6B,SAAS,GAAG,IAAI,mBAAmB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAC7F,CAAC;AACJ,CAAC"}
|