checkly 8.2.0-prerelease-169e1f4 → 8.3.0-prerelease-d81dc3d

package/dist/ai-context/public-skills/checkly/SKILL.md

@@ -1,6 +1,6 @@
 ---
 name: checkly
-description: Set up, create, test and manage monitoring checks using the Checkly CLI. Use when working with Agentic Checks, API Checks, Browser Checks, URL Monitors, ICMP Monitors, Playwright Check Suites, Heartbeat Monitors, Alert Channels, Dashboards, or Status Pages. Access Checkly account plan, entitlements, feature limits, members, and pending invites.
+description: Set up, create, test and manage monitoring checks using the Checkly CLI. Use when working with Agentic Checks, API Checks, Browser Checks, URL Monitors, ICMP Monitors, Playwright Check Suites, Heartbeat Monitors, Alert Channels, Dashboards, or Status Pages. Access Checkly account plan, entitlements, feature limits, members, and pending invites. Includes generic API pass-through (`checkly api`) for endpoints without dedicated commands.
 allowed-tools: Bash(npx:checkly:*) Bash(npm:install:*)
 metadata:
   author: checkly
@@ -36,6 +36,64 @@ Write commands (e.g. `incidents create`, `deploy`, `destroy`) return exit code 2
 
 Run `npx checkly skills communicate` for the full protocol details.
 
+## API Pass-Through (fallback for any endpoint)
+
+When no dedicated CLI command exists for an endpoint, use `npx checkly api` to make authenticated requests directly. The CLI handles auth headers and base URL automatically.
+
+```bash
+npx checkly api /v1/checks
+npx checkly api /v1/dashboards -X GET --jq '.[].name'
+npx checkly api /v1/checks -X POST -F name=MyCheck -F activated:=true
+npx checkly api /v1/checks -X GET -F limit=5
+```
+
+Key flags: `-X` (method), `-F` (field — `key=value` for strings, `key:=value` for JSON), `-H` (header), `--jq` (filter with jq), `--input` (body from file/stdin), `-i` / `--include` (response status + headers on stdout), `--verbose` (request/response headers on stderr).
+
+### Nested payloads
+
+Use `:=` to send structured JSON in a single field:
+
+```bash
+npx checkly api /v1/checks/<id> -X PATCH \
+  -F retryStrategy:='{"type":"LINEAR","maxRetries":2,"baseBackoffSeconds":10}'
+```
+
+For large or deeply nested bodies, pipe a JSON file via `--input`:
+
+```bash
+npx checkly api /v1/checks -X POST --input ./new-check.json
+```
+
+### Pagination
+
+`checkly api` does not auto-walk pages. Drive pagination yourself, the same way every other `checkly` list command exposes it.
+
+When using `-F` on a read endpoint, **always pass `-X GET` explicitly** — any `-F` flag implies POST unless the method is set, so omitting `-X GET` will try to create a resource with your pagination params as the body.
+
+**Detecting which pagination style an endpoint uses.** Make a first request with `-i` (response headers on stdout) and inspect what came back:
+
+- **Page-based** → response has a `content-range` header (e.g. `0-1/23` means items 0–1 of 23 total) and usually a `link` header with `rel="next"` / `rel="last"`. The body is a bare array. Walk by incrementing `-F page=N` until you've covered the total in `content-range`, or until the `rel="next"` link disappears.
+- **Cursor-based** → response body is an envelope like `{ entries: [...], nextId: "...", length: N }`. Pass `-F nextId=<value>` (or `-F cursor=<value>`, depending on the endpoint) on the next call. When `nextId` is missing or null, you've reached the end.
+
+```bash
+# Step 1: make the first call with -i and inspect the response shape
+npx checkly api /v1/checks -X GET -F limit=100 -i
+
+# If you saw a content-range header → page-based, walk with -F page=N
+npx checkly api /v1/checks -X GET -F limit=100 -F page=2 -i
+
+# If the body had a nextId field → cursor-based, walk with -F nextId=<value>
+npx checkly api /v1/status-pages -X GET -F limit=50 -F nextId=<nextIdFromPrevResponse>
+```
+
+### Error responses
+
+On non-2xx, the response body is still written to stdout (read it for the API's error message) and the CLI exits with code 1. A 401 prints an auth hint, a 403 prints a permission hint, and a 404 prints the docs URL — all on stderr.
+
+### Endpoint discovery
+
+See the [Checkly API reference](https://www.checklyhq.com/docs/api) for the human-readable endpoint catalogue, or fetch the [OpenAPI spec](https://api.checklyhq.com/openapi.json) for a machine-readable definition you can grep for paths, parameters, and response shapes.
+
 ### `npx checkly skills initialize`
 Learn how to initialize and set up a new Checkly CLI project from scratch.
 

package/dist/commands/api.d.ts

@@ -0,0 +1,23 @@
+import { AuthCommand } from './authCommand.js';
+export default class Api extends AuthCommand {
+    static hidden: boolean;
+    static readOnly: boolean;
+    static destructive: boolean;
+    static idempotent: boolean;
+    static description: string;
+    static examples: string[];
+    static args: {
+        endpoint: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        method: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        field: import("@oclif/core/interfaces").OptionFlag<string[], import("@oclif/core/interfaces").CustomOptions>;
+        header: import("@oclif/core/interfaces").OptionFlag<string[], import("@oclif/core/interfaces").CustomOptions>;
+        jq: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        input: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        include: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private applyJq;
+}

package/dist/commands/api.js

@@ -0,0 +1,205 @@
+import { Args, Flags } from '@oclif/core';
+import { execFile } from 'node:child_process';
+import { readFile } from 'node:fs/promises';
+import { AuthCommand } from './authCommand.js';
+import { api } from '../rest/api.js';
+import { parseFields } from '../helpers/api-fields.js';
+const WRITE_METHODS = new Set(['POST', 'PUT', 'PATCH']);
+export default class Api extends AuthCommand {
+    static hidden = false;
+    static readOnly = false;
+    static destructive = true;
+    static idempotent = false;
+    static description = 'Make an authenticated HTTP request to the Checkly API.\n'
+        + 'Pass-through for any endpoint — handles auth automatically.\n'
+        + 'See https://www.checklyhq.com/docs/api for available endpoints.\n'
+        + 'OpenAPI spec: https://api.checklyhq.com/openapi.json';
+    static examples = [
+        'checkly api /v1/checks',
+        'checkly api /v1/checks -X GET --jq \'.[].name\'',
+        'checkly api /v1/checks -X POST -F name=MyCheck -F activated:=true',
+        'checkly api /v1/checks -X GET -F limit=5',
+        'echo \'{"name":"New"}\' | checkly api /v1/checks -X POST --input -',
+    ];
+    static args = {
+        endpoint: Args.string({
+            description: 'API endpoint path (e.g. /v1/checks).',
+            required: true,
+        }),
+    };
+    /* eslint-disable @stylistic/quote-props */
+    static flags = {
+        'method': Flags.string({
+            char: 'X',
+            description: 'HTTP method.',
+            options: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'],
+        }),
+        'field': Flags.string({
+            char: 'F',
+            description: 'Add a field: key=value (string) or key:=value (parsed as JSON).',
+            multiple: true,
+            default: [],
+        }),
+        'header': Flags.string({
+            char: 'H',
+            description: 'Custom HTTP header: "Key: Value".',
+            multiple: true,
+            default: [],
+        }),
+        'jq': Flags.string({
+            description: 'Filter JSON output with a jq expression (requires jq installed).',
+        }),
+        'input': Flags.string({
+            description: 'Request body from file path, or "-" for stdin.',
+        }),
+        'include': Flags.boolean({
+            char: 'i',
+            description: 'Include HTTP status and response headers in the output.',
+            default: false,
+        }),
+        'verbose': Flags.boolean({
+            description: 'Print request and response headers to stderr.',
+            default: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(Api);
+        const hasFields = flags.field.length > 0;
+        const method = (flags.method ?? (hasFields || flags.input ? 'POST' : 'GET')).toUpperCase();
+        if (args.endpoint.startsWith('//') || /^[a-z][a-z\d+\-.]*:/i.test(args.endpoint)) {
+            this.error('Endpoint must be a relative path (e.g. /v1/checks), not a URL.');
+        }
+        const endpoint = args.endpoint.startsWith('/') ? args.endpoint : `/${args.endpoint}`;
+        const baseUrl = api.defaults.baseURL;
+        if (baseUrl) {
+            const resolved = new URL(endpoint, baseUrl);
+            if (resolved.origin !== new URL(baseUrl).origin) {
+                this.error('Endpoint must be a relative path (e.g. /v1/checks), not a URL.');
+            }
+        }
+        const fields = hasFields ? parseFields(flags.field) : undefined;
+        if (flags.input && hasFields) {
+            this.error('Cannot use --input together with -F/--field.');
+        }
+        let data;
+        if (flags.input) {
+            const raw = flags.input === '-' ? await readStdin() : await readFile(flags.input, 'utf-8');
+            try {
+                data = JSON.parse(raw);
+            }
+            catch {
+                data = raw;
+            }
+        }
+        else if (fields && WRITE_METHODS.has(method)) {
+            data = fields;
+        }
+        const params = fields && !WRITE_METHODS.has(method) ? fields : undefined;
+        const customHeaders = {};
+        for (const h of flags.header) {
+            const colonIndex = h.indexOf(':');
+            if (colonIndex === -1) {
+                this.error(`Invalid header format: "${h}". Expected "Key: Value".`);
+            }
+            customHeaders[h.slice(0, colonIndex).trim()] = h.slice(colonIndex + 1).trim();
+        }
+        const requestConfig = {
+            method,
+            url: endpoint,
+            params,
+            data,
+            headers: customHeaders,
+            validateStatus: () => true,
+        };
+        if (flags.verbose) {
+            this.logToStderr(`> ${method} ${endpoint}`);
+            for (const [k, v] of Object.entries(customHeaders)) {
+                this.logToStderr(`> ${k}: ${v}`);
+            }
+            this.logToStderr('');
+        }
+        const response = await api.request(requestConfig);
+        if (flags.verbose) {
+            this.logToStderr(`< ${response.status} ${response.statusText}`);
+            for (const [k, v] of Object.entries(response.headers)) {
+                if (v !== undefined) {
+                    this.logToStderr(`< ${k}: ${v}`);
+                }
+            }
+            this.logToStderr('');
+        }
+        const responseData = response.data;
+        if (flags.include) {
+            this.log(`HTTP/1.1 ${response.status} ${response.statusText}`);
+            for (const [k, v] of Object.entries(response.headers)) {
+                if (v !== undefined) {
+                    this.log(`${k}: ${v}`);
+                }
+            }
+            this.log();
+        }
+        if (responseData === undefined || responseData === null || responseData === '') {
+            if (response.status >= 400) {
+                this.exit(1);
+            }
+            return;
+        }
+        const json = typeof responseData === 'string' ? responseData : formatJson(responseData);
+        if (flags.jq) {
+            await this.applyJq(json, flags.jq);
+        }
+        else {
+            this.log(json);
+        }
+        if (response.status === 404) {
+            this.logToStderr('Endpoint not found. See available endpoints at https://www.checklyhq.com/docs/api');
+        }
+        else if (response.status === 401) {
+            this.logToStderr('Authentication failed — run "checkly login" or set CHECKLY_API_KEY.');
+        }
+        else if (response.status === 403) {
+            this.logToStderr('Permission denied — verify your account role and API key scope.');
+        }
+        if (response.status >= 400) {
+            this.exit(1);
+        }
+    }
+    applyJq(json, filter) {
+        return new Promise((resolve, reject) => {
+            const child = execFile('jq', [filter], { encoding: 'utf-8' }, (error, stdout, stderr) => {
+                if (error) {
+                    if (error.code === 'ENOENT') {
+                        reject(new Error('--jq requires jq to be installed.\n'
+                            + 'Install it from https://jqlang.github.io/jq/'));
+                        return;
+                    }
+                    reject(new Error(`jq failed: ${stderr || error.message}`));
+                    return;
+                }
+                if (stderr) {
+                    this.logToStderr(stderr);
+                }
+                if (stdout) {
+                    this.log(stdout.trimEnd());
+                }
+                resolve();
+            });
+            child.stdin?.write(json);
+            child.stdin?.end();
+        });
+    }
+}
+function formatJson(data) {
+    if (process.stdout.isTTY) {
+        return JSON.stringify(data, null, 2);
+    }
+    return JSON.stringify(data);
+}
+async function readStdin() {
+    const chunks = [];
+    for await (const chunk of process.stdin) {
+        chunks.push(chunk);
+    }
+    return Buffer.concat(chunks).toString('utf-8');
+}
+//# sourceMappingURL=api.js.map

package/dist/commands/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/commands/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AAEtD,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;AAEvD,MAAM,CAAC,OAAO,OAAO,GAAI,SAAQ,WAAW;IAC1C,MAAM,CAAC,MAAM,GAAG,KAAK,CAAA;IACrB,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAA;IACvB,MAAM,CAAC,WAAW,GAAG,IAAI,CAAA;IACzB,MAAM,CAAC,UAAU,GAAG,KAAK,CAAA;IACzB,MAAM,CAAC,WAAW,GAAG,0DAA0D;UAC3E,+DAA+D;UAC/D,mEAAmE;UACnE,sDAAsD,CAAA;IAE1D,MAAM,CAAC,QAAQ,GAAG;QAChB,wBAAwB;QACxB,iDAAiD;QACjD,mEAAmE;QACnE,0CAA0C;QAC1C,oEAAoE;KACrE,CAAA;IAED,MAAM,CAAC,IAAI,GAAG;QACZ,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC;YACpB,WAAW,EAAE,sCAAsC;YACnD,QAAQ,EAAE,IAAI;SACf,CAAC;KACH,CAAA;IAED,2CAA2C;IAC3C,MAAM,CAAC,KAAK,GAAG;QACb,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,cAAc;YAC3B,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC;SACnD,CAAC;QACF,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC;YACpB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,iEAAiE;YAC9E,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE;SACZ,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,mCAAmC;YAChD,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE;SACZ,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,WAAW,EAAE,kEAAkE;SAChF,CAAC;QACF,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC;YACpB,WAAW,EAAE,gDAAgD;SAC9D,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;YACvB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,yDAAyD;YACtE,OAAO,EAAE,KAAK;SACf,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;YACvB,WAAW,EAAE,+CAA+C;YAC5D,OAAO,EAAE,KAAK;SACf,CAAC;KACH,CAAA;IAED,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAE7C,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAA;QACxC,MAAM,MAAM,GAAG,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,EAAE,CAAA;QAE1F,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjF,IAAI,CAAC,KAAK,CAAC,gEAAgE,CAAC,CAAA;QAC9E,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAA;QAEpF,MAAM,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAA;QACpC,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;YAC3C,IAAI,QAAQ,CAAC,MAAM,KAAK,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;gBAChD,IAAI,CAAC,KAAK,CAAC,gEAAgE,CAAC,CAAA;YAC9E,CAAC;QACH,CAAC;QAED,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAE/D,IAAI,KAAK,CAAC,KAAK,IAAI,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAA;QAC5D,CAAC;QAED,IAAI,IAAa,CAAA;QACjB,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,SAAS,EAAE,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;YAC1F,IAAI,CAAC;gBACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACxB,CAAC;YAAC,MAAM,CAAC;gBACP,IAAI,GAAG,GAAG,CAAA;YACZ,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,IAAI,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/C,IAAI,GAAG,MAAM,CAAA;QACf,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;QAExE,MAAM,aAAa,GAA2B,EAAE,CAAA;QAChD,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YAC7B,MAAM,UAAU,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;YACjC,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;gBACtB,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,2BAA2B,CAAC,CAAA;YACrE,CAAC;YACD,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;QAC/E,CAAC;QAED,MAAM,aAAa,GAAG;YACpB,MAAM;YACN,GAAG,EAAE,QAAQ;YACb,MAAM;YACN,IAAI;YACJ,OAAO,EAAE,aAAa;YACtB,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI;SAC3B,CAAA;QAED,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,WAAW,CAAC,KAAK,MAAM,IAAI,QAAQ,EAAE,CAAC,CAAA;YAC3C,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;gBACnD,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;YAClC,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;QACtB,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;QAEjD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,WAAW,CAAC,KAAK,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAA;YAC/D,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBACtD,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;oBACpB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;gBAClC,CAAC;YACH,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;QACtB,CAAC;QAED,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAA;QAElC,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,YAAY,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAA;YAC9D,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBACtD,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;oBACpB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;gBACxB,CAAC;YACH,CAAC;YACD,IAAI,CAAC,GAAG,EAAE,CAAA;QACZ,CAAC;QAED,IAAI,YAAY,KAAK,SAAS,IAAI,YAAY,KAAK,IAAI,IAAI,YAAY,KAAK,EAAE,EAAE,CAAC;YAC/E,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;gBAC3B,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACd,CAAC;YACD,OAAM;QACR,CAAC;QAED,MAAM,IAAI,GAAG,OAAO,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,CAAA;QAEvF,IAAI,KAAK,CAAC,EAAE,EAAE,CAAC;YACb,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,CAAA;QACpC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAChB,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,IAAI,CAAC,WAAW,CAAC,mFAAmF,CAAC,CAAA;QACvG,CAAC;aAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACnC,IAAI,CAAC,WAAW,CAAC,qEAAqE,CAAC,CAAA;QACzF,CAAC;aAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACnC,IAAI,CAAC,WAAW,CAAC,iEAAiE,CAAC,CAAA;QACrF,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACd,CAAC;IACH,CAAC;IAEO,OAAO,CAAE,IAAY,EAAE,MAAc;QAC3C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;gBACtF,IAAI,KAAK,EAAE,CAAC;oBACV,IAAK,KAA+B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;wBACvD,MAAM,CAAC,IAAI,KAAK,CACd,qCAAqC;8BACnC,8CAA8C,CACjD,CAAC,CAAA;wBACF,OAAM;oBACR,CAAC;oBACD,MAAM,CAAC,IAAI,KAAK,CAAC,cAAc,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;oBAC1D,OAAM;gBACR,CAAC;gBACD,IAAI,MAAM,EAAE,CAAC;oBACX,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;gBAC1B,CAAC;gBACD,IAAI,MAAM,EAAE,CAAC;oBACX,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;gBAC5B,CAAC;gBACD,OAAO,EAAE,CAAA;YACX,CAAC,CAAC,CAAA;YACF,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;YACxB,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,CAAA;QACpB,CAAC,CAAC,CAAA;IACJ,CAAC;;AAGH,SAAS,UAAU,CAAE,IAAa;IAChC,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IACtC,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;AAC7B,CAAC;AAED,KAAK,UAAU,SAAS;IACtB,MAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QACxC,MAAM,CAAC,IAAI,CAAC,KAAe,CAAC,CAAA;IAC9B,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;AAChD,CAAC"}

package/dist/constructs/slack-app-alert-channel.d.ts

@@ -1,5 +1,11 @@
 import { AlertChannel, AlertChannelProps } from './alert-channel.js';
 export interface SlackAppAlertChannelProps extends AlertChannelProps {
+    /**
+     * List of Slack #channels or @handles to notify.
+     * Private channels require the Checkly app to be invited first.
+     * @example
+     * ['#alerts', '#ops', '@alice']
+     */
     slackChannels: string[];
 }
 /**

package/dist/constructs/slack-app-alert-channel.js.map

@@ -1 +1 @@
-{"version":3,"file":"slack-app-alert-channel.js","sourceRoot":"","sources":["../../src/constructs/slack-app-alert-channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAqB,MAAM,oBAAoB,CAAA;AACpE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAMtC;;;;;;GAMG;AACH,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IACpD,aAAa,CAAU;IACvB;;;;;;;OAOG;IACH,YAAa,SAAiB,EAAE,KAAgC;QAC9D,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QACvB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAA;QACxC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED,QAAQ;QACN,OAAO,wBAAwB,IAAI,CAAC,SAAS,EAAE,CAAA;IACjD,CAAC;IAED,UAAU;QACR,OAAO;YACL,GAAG,KAAK,CAAC,UAAU,EAAE;YACrB,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE;gBACN,aAAa,EAAE,IAAI,CAAC,aAAa;aAClC;SACF,CAAA;IACH,CAAC;CACF"}
+{"version":3,"file":"slack-app-alert-channel.js","sourceRoot":"","sources":["../../src/constructs/slack-app-alert-channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAqB,MAAM,oBAAoB,CAAA;AACpE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAYtC;;;;;;GAMG;AACH,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IACpD,aAAa,CAAU;IACvB;;;;;;;OAOG;IACH,YAAa,SAAiB,EAAE,KAAgC;QAC9D,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QACvB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAA;QACxC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED,QAAQ;QACN,OAAO,wBAAwB,IAAI,CAAC,SAAS,EAAE,CAAA;IACjD,CAAC;IAED,UAAU;QACR,OAAO;YACL,GAAG,KAAK,CAAC,UAAU,EAAE;YACrB,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE;gBACN,aAAa,EAAE,IAAI,CAAC,aAAa;aAClC;SACF,CAAA;IACH,CAAC;CACF"}

package/dist/help/examples.js

@@ -11,6 +11,10 @@ const examples = [
         description: 'Deploy your project to your Checkly account.',
         command: 'npx checkly deploy',
     },
+    {
+        description: 'Make an authenticated API request to any endpoint.',
+        command: 'npx checkly api /v1/checks',
+    },
 ];
 export default examples;
 //# sourceMappingURL=examples.js.map

package/dist/help/examples.js.map

@@ -1 +1 @@
-{"version":3,"file":"examples.js","sourceRoot":"","sources":["../../src/help/examples.ts"],"names":[],"mappings":"AAKA,MAAM,QAAQ,GAAmB;IAC/B;QACE,WAAW,EAAE,+DAA+D;QAC5E,OAAO,EAAE,kBAAkB;KAC5B;IACD;QACE,WAAW,EAAE,4CAA4C;QACzD,OAAO,EAAE,wCAAwC;KAClD;IACD;QACE,WAAW,EAAE,8CAA8C;QAC3D,OAAO,EAAE,oBAAoB;KAC9B;CACF,CAAA;AACD,eAAe,QAAQ,CAAA"}
+{"version":3,"file":"examples.js","sourceRoot":"","sources":["../../src/help/examples.ts"],"names":[],"mappings":"AAKA,MAAM,QAAQ,GAAmB;IAC/B;QACE,WAAW,EAAE,+DAA+D;QAC5E,OAAO,EAAE,kBAAkB;KAC5B;IACD;QACE,WAAW,EAAE,4CAA4C;QACzD,OAAO,EAAE,wCAAwC;KAClD;IACD;QACE,WAAW,EAAE,8CAA8C;QAC3D,OAAO,EAAE,oBAAoB;KAC9B;IACD;QACE,WAAW,EAAE,oDAAoD;QACjE,OAAO,EAAE,4BAA4B;KACtC;CACF,CAAA;AACD,eAAe,QAAQ,CAAA"}

package/dist/helpers/api-fields.d.ts

@@ -0,0 +1,4 @@
+export interface ParsedFields {
+    [key: string]: unknown;
+}
+export declare function parseFields(fields: string[]): ParsedFields;

package/dist/helpers/api-fields.js

@@ -0,0 +1,24 @@
+export function parseFields(fields) {
+    const result = {};
+    for (const entry of fields) {
+        const jsonIndex = entry.indexOf(':=');
+        if (jsonIndex !== -1) {
+            const key = entry.slice(0, jsonIndex);
+            const raw = entry.slice(jsonIndex + 2);
+            try {
+                result[key] = JSON.parse(raw);
+            }
+            catch {
+                throw new Error(`Invalid JSON in field "${key}": ${raw}`);
+            }
+            continue;
+        }
+        const eqIndex = entry.indexOf('=');
+        if (eqIndex === -1) {
+            throw new Error(`Invalid field format: "${entry}". Expected key=value or key:=json.`);
+        }
+        result[entry.slice(0, eqIndex)] = entry.slice(eqIndex + 1);
+    }
+    return result;
+}
+//# sourceMappingURL=api-fields.js.map

package/dist/helpers/api-fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-fields.js","sourceRoot":"","sources":["../../src/helpers/api-fields.ts"],"names":[],"mappings":"AAIA,MAAM,UAAU,WAAW,CAAE,MAAgB;IAC3C,MAAM,MAAM,GAAiB,EAAE,CAAA;IAE/B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACrC,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;YACrB,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAA;YACrC,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAA;YACtC,IAAI,CAAC;gBACH,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC/B,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,IAAI,KAAK,CAAC,0BAA0B,GAAG,MAAM,GAAG,EAAE,CAAC,CAAA;YAC3D,CAAC;YACD,SAAQ;QACV,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAClC,IAAI,OAAO,KAAK,CAAC,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,0BAA0B,KAAK,qCAAqC,CAAC,CAAA;QACvF,CAAC;QACD,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,CAAA;IAC5D,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/helpers/content-range.d.ts

@@ -0,0 +1 @@
+export declare function parseTotalFromContentRange(header: string | undefined): number | null;

package/dist/helpers/content-range.js

@@ -0,0 +1,7 @@
+export function parseTotalFromContentRange(header) {
+    if (!header)
+        return null;
+    const match = header.match(/\/(\d+)$/);
+    return match ? parseInt(match[1], 10) : null;
+}
+//# sourceMappingURL=content-range.js.map

package/dist/helpers/content-range.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-range.js","sourceRoot":"","sources":["../../src/helpers/content-range.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,0BAA0B,CAAE,MAA0B;IACpE,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAA;IACxB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;IACtC,OAAO,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;AAC9C,CAAC"}

package/dist/rest/checks.js

@@ -1,10 +1,4 @@
-function parseTotalFromContentRange(header) {
-    if (!header)
-        return null;
-    // Content-Range format: "0-24/300" or "*/0"
-    const match = header.match(/\/(\d+)$/);
-    return match ? parseInt(match[1], 10) : null;
-}
+import { parseTotalFromContentRange } from '../helpers/content-range.js';
 class Checks {
     api;
     constructor(api) {

package/dist/rest/checks.js.map

@@ -1 +1 @@
-{"version":3,"file":"checks.js","sourceRoot":"","sources":["../../src/rest/checks.ts"],"names":[],"mappings":"AAuCA,SAAS,0BAA0B,CAAE,MAA0B;IAC7D,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAA;IACxB,4CAA4C;IAC5C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;IACtC,OAAO,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;AAC9C,CAAC;AAED,MAAM,MAAM;IACV,GAAG,CAAe;IAClB,YAAa,GAAkB;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,MAAM,CAAE,SAA2B,EAAE;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAU,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;IACxD,CAAC;IAED,KAAK,CAAC,eAAe,CAAE,SAA2B,EAAE;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAU,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;QACtE,MAAM,KAAK,GAAG,0BAA0B,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAA;QACnG,OAAO;YACL,MAAM,EAAE,QAAQ,CAAC,IAAI;YACrB,KAAK;YACL,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC;YACtB,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,EAAE;SAC1B,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAE,SAAmD,EAAE;QACnE,MAAM,QAAQ,GAAG,GAAG,CAAA;QACpB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAA;QACjF,MAAM,SAAS,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;QAEnC,IAAI,KAAK,CAAC,KAAK,IAAI,QAAQ;YAAE,OAAO,SAAS,CAAA;QAE7C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,CAAA;QACpD,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,GAAG,CACjC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAC9C,IAAI,CAAC,GAAG,CAAC,GAAG,CAAU,YAAY,EAAE;YAClC,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE;SACpD,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CACrB,CACF,CAAA;QACD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAA;QACzB,CAAC;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,GAAG,CAAE,EAAU;QACb,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAQ,cAAc,EAAE,EAAE,CAAC,CAAA;IAChD,CAAC;CACF;AAED,eAAe,MAAM,CAAA"}
+{"version":3,"file":"checks.js","sourceRoot":"","sources":["../../src/rest/checks.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAA;AAuCxE,MAAM,MAAM;IACV,GAAG,CAAe;IAClB,YAAa,GAAkB;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,MAAM,CAAE,SAA2B,EAAE;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAU,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;IACxD,CAAC;IAED,KAAK,CAAC,eAAe,CAAE,SAA2B,EAAE;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAU,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;QACtE,MAAM,KAAK,GAAG,0BAA0B,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAA;QACnG,OAAO;YACL,MAAM,EAAE,QAAQ,CAAC,IAAI;YACrB,KAAK;YACL,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC;YACtB,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,EAAE;SAC1B,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAE,SAAmD,EAAE;QACnE,MAAM,QAAQ,GAAG,GAAG,CAAA;QACpB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAA;QACjF,MAAM,SAAS,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;QAEnC,IAAI,KAAK,CAAC,KAAK,IAAI,QAAQ;YAAE,OAAO,SAAS,CAAA;QAE7C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,CAAA;QACpD,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,GAAG,CACjC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAC9C,IAAI,CAAC,GAAG,CAAC,GAAG,CAAU,YAAY,EAAE;YAClC,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE;SACpD,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CACrB,CACF,CAAA;QACD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAA;QACzB,CAAC;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,GAAG,CAAE,EAAU;QACb,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAQ,cAAc,EAAE,EAAE,CAAC,CAAA;IAChD,CAAC;CACF;AAED,eAAe,MAAM,CAAA"}