checkly 8.19.0 → 8.20.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.
Files changed (71) hide show
  1. package/dist/ai-context/context.d.ts +0 -6
  2. package/dist/ai-context/context.js +0 -9
  3. package/dist/ai-context/context.js.map +1 -1
  4. package/dist/ai-context/public-skills/checkly/SKILL.md +2 -2
  5. package/dist/ai-context/skills-command/references/configure-playwright-checks.md +1 -0
  6. package/dist/ai-context/skills-command/references/configure.md +1 -4
  7. package/dist/ai-context/skills-command/references/initialize.md +1 -1
  8. package/dist/ai-context/skills-command/references/investigate-test-sessions.md +1 -1
  9. package/dist/ai-context/skills-command/references/manage-plan.md +1 -1
  10. package/dist/ai-context/skills-command/references/manage.md +3 -3
  11. package/dist/commands/account/plan.d.ts +13 -0
  12. package/dist/commands/account/plan.js +3 -2
  13. package/dist/commands/account/plan.js.map +1 -1
  14. package/dist/commands/debug/parse-project.js +3 -1
  15. package/dist/commands/debug/parse-project.js.map +1 -1
  16. package/dist/commands/deploy.js +3 -1
  17. package/dist/commands/deploy.js.map +1 -1
  18. package/dist/commands/pw-test.js +3 -1
  19. package/dist/commands/pw-test.js.map +1 -1
  20. package/dist/commands/test.js +3 -1
  21. package/dist/commands/test.js.map +1 -1
  22. package/dist/formatters/account-plan.d.ts +2 -2
  23. package/dist/formatters/account-plan.js +6 -6
  24. package/dist/formatters/account-plan.js.map +1 -1
  25. package/dist/rest/account-members.d.ts +3 -3
  26. package/dist/rest/accounts.d.ts +2 -2
  27. package/dist/rest/api.d.ts +1 -1
  28. package/dist/rest/batch-analytics.d.ts +1 -1
  29. package/dist/rest/cancel.d.ts +6 -2
  30. package/dist/rest/check-groups.d.ts +1 -1
  31. package/dist/rest/check-results.d.ts +2 -2
  32. package/dist/rest/check-statuses.d.ts +2 -2
  33. package/dist/rest/checkly-storage.d.ts +5 -3
  34. package/dist/rest/checks.d.ts +3 -3
  35. package/dist/rest/entitlements.d.ts +1 -1
  36. package/dist/rest/environment-variables.d.ts +14 -5
  37. package/dist/rest/error-groups.d.ts +2 -2
  38. package/dist/rest/heartbeat-checks.d.ts +1 -1
  39. package/dist/rest/locations.d.ts +1 -1
  40. package/dist/rest/private-locations.d.ts +1 -1
  41. package/dist/rest/projects.d.ts +11 -11
  42. package/dist/rest/rca.d.ts +3 -3
  43. package/dist/rest/test-session-error-groups.d.ts +1 -1
  44. package/dist/rest/test-sessions.d.ts +9 -9
  45. package/dist/rest/users.d.ts +1 -1
  46. package/dist/services/check-parser/bundler.d.ts +2 -1
  47. package/dist/services/check-parser/bundler.js +112 -17
  48. package/dist/services/check-parser/bundler.js.map +1 -1
  49. package/dist/services/check-parser/cache-hash.d.ts +29 -1
  50. package/dist/services/check-parser/cache-hash.js +30 -1
  51. package/dist/services/check-parser/cache-hash.js.map +1 -1
  52. package/dist/services/check-parser/parser.d.ts +18 -0
  53. package/dist/services/check-parser/parser.js +9 -2
  54. package/dist/services/check-parser/parser.js.map +1 -1
  55. package/dist/services/check-parser/playwright-config-expander.d.ts +10 -1
  56. package/dist/services/check-parser/playwright-config-expander.js +87 -8
  57. package/dist/services/check-parser/playwright-config-expander.js.map +1 -1
  58. package/dist/services/checkly-config-loader.d.ts +28 -0
  59. package/dist/services/checkly-config-loader.js +10 -0
  60. package/dist/services/checkly-config-loader.js.map +1 -1
  61. package/dist/services/playwright-config.d.ts +14 -0
  62. package/dist/services/playwright-config.js +62 -9
  63. package/dist/services/playwright-config.js.map +1 -1
  64. package/dist/services/playwright-project-bundler.js +42 -5
  65. package/dist/services/playwright-project-bundler.js.map +1 -1
  66. package/dist/services/symlink-resolver.d.ts +56 -0
  67. package/dist/services/symlink-resolver.js +860 -0
  68. package/dist/services/symlink-resolver.js.map +1 -0
  69. package/oclif.manifest.json +447 -447
  70. package/package.json +14 -14
  71. package/dist/ai-context/skills-command/references/configure-agentic-checks.md +0 -65
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "checkly",
3
- "version": "8.19.0",
3
+ "version": "8.20.0",
4
4
  "type": "module",
5
5
  "description": "Checkly CLI",
6
6
  "main": "dist/index.js",
@@ -96,15 +96,15 @@
96
96
  },
97
97
  "homepage": "https://github.com/checkly/checkly-cli#readme",
98
98
  "dependencies": {
99
- "@oclif/core": "^4.13.0",
100
- "@oclif/plugin-help": "^6.2.53",
101
- "@oclif/plugin-warn-if-update-available": "^3.1.68",
102
- "@typescript-eslint/typescript-estree": "^8.65.0",
103
- "acorn": "^8.17.0",
99
+ "@oclif/core": "^4.13.3",
100
+ "@oclif/plugin-help": "^6.2.56",
101
+ "@oclif/plugin-warn-if-update-available": "^3.1.71",
102
+ "@typescript-eslint/typescript-estree": "^8.66.0",
103
+ "acorn": "^8.18.0",
104
104
  "acorn-walk": "^8.3.5",
105
105
  "archiver": "^8.0.0",
106
106
  "ast-types": "^0.16.1",
107
- "axios": "^1.18.1",
107
+ "axios": "^1.19.0",
108
108
  "chalk": "^5.6.2",
109
109
  "ci-info": "^4.4.0",
110
110
  "conf": "^15.1.0",
@@ -122,13 +122,13 @@
122
122
  "jwt-decode": "^4.0.0",
123
123
  "log-symbols": "^7.0.1",
124
124
  "luxon": "^3.7.2",
125
- "minimatch": "^10.2.5",
125
+ "minimatch": "^10.2.6",
126
126
  "mqtt": "^5.15.2",
127
127
  "open": "^11.0.0",
128
128
  "p-queue": "^9.3.3",
129
129
  "prompts": "^2.4.2",
130
130
  "proxy-from-env": "^2.1.0",
131
- "recast": "^0.23.12",
131
+ "recast": "^0.23.19",
132
132
  "semver": "^7.8.5",
133
133
  "socks-proxy-agent": "^10.1.0",
134
134
  "string-width": "^8.2.2",
@@ -136,18 +136,18 @@
136
136
  "yaml": "^2.9.0"
137
137
  },
138
138
  "devDependencies": {
139
- "@playwright/test": "^1.62.0",
139
+ "@playwright/test": "^1.62.1",
140
140
  "@types/archiver": "^8.0.0",
141
141
  "@types/debug": "^4.1.13",
142
- "@types/luxon": "^3.7.2",
142
+ "@types/luxon": "^3.7.4",
143
143
  "@types/node": "^22.19.17",
144
144
  "@types/prompts": "^2.4.9",
145
- "@types/semver": "^7.7.1",
145
+ "@types/semver": "^7.8.0",
146
146
  "@types/ws": "^8.5.5",
147
- "config": "^4.4.2",
147
+ "config": "^5.0.0",
148
148
  "cross-env": "^10.1.0",
149
149
  "nanoid": "^5.1.16",
150
- "oclif": "^4.23.29",
150
+ "oclif": "^4.23.30",
151
151
  "rimraf": "^6.1.3",
152
152
  "tar": "^7.5.22",
153
153
  "typescript": "^6.0.3",
@@ -1,65 +0,0 @@
1
- # Agentic Checks
2
-
3
- - Import the `AgenticCheck` construct from `checkly/constructs`.
4
- - Agentic checks are AI-powered: instead of writing code, you describe what the check should do in natural language with the `prompt` property. The agent decides how to satisfy the prompt at runtime.
5
- - Write prompts as concrete imperative steps, not vague goals. Tell the agent which URL to navigate to and what specific signals confirm success — for example, "Navigate to https://example.com/pricing and verify that at least three plan tiers are displayed", not "Check that pricing works".
6
- - Keep prompts under 10000 characters. The construct will fail validation otherwise.
7
- - **Frequency is entitlement-gated by the backend.** You can configure the same `frequency` values as other checks, including `Frequency.EVERY_5M` / `5`. The backend enforces the fastest cadence available to the account.
8
- - **Locations are entitlement-gated by the backend.** You can pass `locations` just like other public checks. The backend enforces the allowed number of regions for the account. `privateLocations` are not supported.
9
- - **Several common check fields are intentionally omitted** from `AgenticCheckProps`: `runParallel`, `retryStrategy`, `shouldFail`, `doubleCheck`, `triggerIncident`, and `groupId`. The platform does not yet honor these for agentic checks. Setting them in the construct is a TypeScript error.
10
- - **Important:** The target URL must be publicly accessible. Checks run on Checkly's cloud infrastructure, not locally. If the user is developing against localhost, suggest a tunneling tool (ngrok, cloudflare tunnel) or a preview/staging deployment.
11
- - **Plan-gated:** Agentic checks require the `AGENTIC_CHECKS` entitlement on the account. Run `npx checkly skills manage` to check entitlements before using.
12
-
13
- ## `agentRuntime` skills
14
-
15
- `agentRuntime` is used to add skills the agent may use at execution time.
16
-
17
- ```typescript
18
- agentRuntime: {
19
- // Additional skills to load on top of the runner's defaults (the
20
- // `playwright-cli` skill is preloaded automatically — you don't need
21
- // to declare it). Each entry is passed verbatim to `npx skills add`
22
- // on the runner, so any third-party skill published to https://skills.sh
23
- // works — not just Checkly's own. Supported identifier forms:
24
- // - full URL form: 'https://skills.sh/microsoft/playwright-cli/playwright-cli'
25
- // - owner/repo form: 'addyosmani/web-quality-skills'
26
- // - plain name: 'cost-optimization'
27
- skills: ['addyosmani/web-quality-skills'],
28
- },
29
- ```
30
-
31
- - Reference Checkly environment variables directly in the prompt with double brackets, for example `{{ENVIRONMENT_URL}}`.
32
- - The runner installs each skill via `npx skills add` at the start of every check run. The CLI does not validate the skill identifier at deploy time, so a typo will not surface until the first run.
33
- - The `playwright-cli` skill is preloaded for every agentic check. Only declare additional skills here.
34
-
35
- ## Assertion rules
36
-
37
- The agent generates its own assertion rules on the first successful run, and the platform persists them server-side. **The CLI construct does not expose assertion rules** — do not try to set them. They survive across deploys: importing an existing agentic check via `checkly import` will not surface them in the generated TypeScript, and a subsequent deploy of that file will not erase them on the backend.
38
-
39
- **Reference:** https://www.checklyhq.com/docs/constructs/agentic-check/
40
-
41
- ```typescript
42
- import { AgenticCheck, AlertEscalationBuilder, Frequency } from 'checkly/constructs'
43
-
44
- new AgenticCheck('example-agentic-check', {
45
- name: 'Example Agentic Check',
46
- prompt: 'Navigate to https://www.checklyhq.com/pricing and verify that at least three plan tiers are displayed on the page.',
47
- activated: true,
48
- locations: [
49
- 'us-east-1',
50
- 'eu-west-1',
51
- 'ap-southeast-1',
52
- ],
53
- tags: [
54
- 'app:webshop',
55
- ],
56
- frequency: Frequency.EVERY_5M,
57
- alertEscalationPolicy: AlertEscalationBuilder.runBasedEscalation(1, {
58
- amount: 0,
59
- interval: 5,
60
- }, {
61
- enabled: false,
62
- percentage: 10,
63
- }),
64
- })
65
- ```