@theholocron/checkly-client 1.58.0-alpha.2 → 1.58.0-alpha.4

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import "@theholocron/http-client";
 import { ErrorSink, Logger } from "@theholocron/observability/core";
+/** Options for `createChecklyClient`. */
 interface ChecklyClientOptions {
   /** Checkly API key — sent as a Bearer token. */
   token: string;
@@ -14,29 +15,41 @@ interface ChecklyClientOptions {
   /** Reports transport failures and unexpected 5xx. Defaults to a no-op. */
   errors?: ErrorSink;
 }
+/** The kinds of alert channel Checkly supports. */
 type AlertChannelType = "EMAIL" | "SLACK" | "SLACK_APP" | "WEBHOOK" | "SMS" | "PAGERDUTY" | "OPSGENIE" | "CALL";
+/** The HTTP methods a webhook alert channel can use. */
 type WebhookMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD";
 /**
  * Which service a webhook channel is formatted for. Checkly stores a Discord channel as a plain `WEBHOOK` with this
  * marker and a body template; there is no separate Discord type.
  */
 type WebhookType = "WEBHOOK_DISCORD" | "WEBHOOK_MSTEAMS" | "WEBHOOK_TELEGRAM" | "WEBHOOK_GITHUB" | "WEBHOOK_SPIKE";
+/** A header or query parameter on a webhook channel. */
 interface WebhookKeyValue {
+  /** The header or parameter name. */
   key: string;
+  /** The header or parameter value. */
   value: string;
+  /** Whether the value is locked. */
   locked?: boolean;
 }
 /** The `config` of a `WEBHOOK` channel, as Checkly returns it. */
 interface WebhookConfig {
+  /** The channel's display name. */
   name: string;
   /** Where Checkly posts. For Discord this is a webhook URL and is a secret: anyone holding it can post to the channel. */
   url: string;
+  /** The HTTP method Checkly uses when it posts. */
   method: WebhookMethod;
   /** Handlebars body template with Checkly's `{{VARIABLES}}`. */
   template?: string;
+  /** Extra headers sent with the request. */
   headers?: WebhookKeyValue[];
+  /** Extra query parameters appended to the URL. */
   queryParameters?: WebhookKeyValue[];
+  /** The service the webhook is formatted for, when it is not a plain webhook. */
   webhookType?: WebhookType;
+  /** A secret Checkly sends with the request so the receiver can recognise it. */
   webhookSecret?: string;
 }
 /** A subscription targets exactly one check or one check group. */
@@ -74,6 +87,7 @@ type PassThroughChannelBody = {
   config: Record<string, unknown>;
 };
 type AlertChannelBody = WebhookChannelBody | PassThroughChannelBody;
+/** What to send to Checkly to create or replace an alert channel: its settings plus its type and `config`. */
 type AlertChannelInput = AlertChannelSettings & AlertChannelBody;
 interface AlertChannelRecord {
   id: number;
@@ -87,6 +101,7 @@ interface AlertChannelRecord {
   created_at: string;
   updated_at: string | null;
 }
+/** An alert channel as Checkly returns it: the stored record plus its type and `config`. */
 type AlertChannel = AlertChannelRecord & AlertChannelBody;
 /**
  * The message body of Checkly's own Discord setup (its AI-analysis section left out, since not every account has it), so
@@ -98,33 +113,51 @@ export declare const DISCORD_TEMPLATE = "{\n\t\"content\": null,\n\t\"username\"
  * no run id, and Checkly may answer 404 for it, so callers wait for `lastCheckRunId` before trusting the flags.
  */
 interface CheckStatus {
+  /** The id of the check this status belongs to. */
   checkId: string;
+  /** The check's name. */
   name?: string;
   /** The latest run failed. */
   hasFailures: boolean;
   /** The latest run errored (it could not be carried out), as distinct from failing its assertions. */
   hasErrors?: boolean;
+  /** The check is in a degraded state. */
   isDegraded?: boolean;
   /** Null or absent until the check has run. */
   lastCheckRunId?: string | null;
+  /** The location the latest run was made from. */
   lastRunLocation?: string | null;
+  /** When the status record was created, as an ISO timestamp. */
   created_at?: string;
+  /** When the status last changed, as an ISO timestamp, or `null`. */
   updated_at?: string | null;
 }
+/** What an assertion reads from the response. */
 type AssertionSource = "STATUS_CODE" | "JSON_BODY" | "HEADERS" | "TEXT_BODY" | "RESPONSE_TIME";
+/** How an assertion compares the value it reads with its `target`. */
 type AssertionComparison = "EQUALS" | "NOT_EQUALS" | "HAS_KEY" | "NOT_HAS_KEY" | "HAS_VALUE" | "NOT_HAS_VALUE" | "IS_EMPTY" | "NOT_EMPTY" | "GREATER_THAN" | "LESS_THAN" | "CONTAINS" | "NOT_CONTAINS" | "IS_NULL" | "NOT_NULL";
+/** One check on an API response: read `source`, compare it with `target`. */
 interface Assertion {
+  /** What part of the response to read. */
   source: AssertionSource;
+  /** How to compare the value with `target`. */
   comparison: AssertionComparison;
   /** JSON path / header name the assertion reads — required for JSON_BODY and HEADERS. */
   property?: string;
+  /** The value to compare against. */
   target?: string;
+  /** A regular expression Checkly applies to the value before comparing. */
   regex?: string;
 }
+/** The HTTP methods an API check can use. */
 type HttpMethod = "GET" | "POST" | "PUT" | "HEAD" | "DELETE" | "PATCH";
+/** The request an API check sends. */
 interface ApiCheckRequest {
+  /** The URL to request. */
   url: string;
+  /** The HTTP method to use. */
   method: HttpMethod;
+  /** Assertions on the response; the check passes when all of them hold. */
   assertions?: Assertion[];
   /**
    * Raw request body to send with the check — e.g. simulating a webhook
@@ -135,13 +168,17 @@ interface ApiCheckRequest {
    */
   body?: string;
 }
+/** What to send to Checkly to create or update an API check. */
 interface ApiCheckInput {
+  /** The check's display name. */
   name: string;
   /** Minutes between runs. One of Checkly's fixed frequency values (0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, 1440). Defaults to 10. */
   frequency?: number;
   /** Checkly datacenter region ids (e.g. "us-east-1"). Defaults to the account's configured default. */
   locations?: string[];
+  /** Whether the check runs on its schedule. */
   activated?: boolean;
+  /** Tags attached to the check. */
   tags?: string[];
   /**
    * Inverts pass/fail: when `true`, a response status >= 400 counts as
@@ -154,27 +191,44 @@ interface ApiCheckInput {
    * to `false`.
    */
   shouldFail?: boolean;
+  /** The request the check sends. */
   request: ApiCheckRequest;
 }
+/** An API check as Checkly returns it. */
 interface ApiCheck {
+  /** Checkly's id for the check. */
   id: string;
+  /** The check's display name. */
   name: string;
+  /** The kind of check; always `"API"` here. */
   checkType: "API";
+  /** Whether the check runs on its schedule. */
   activated: boolean;
+  /** Minutes between runs. */
   frequency: number;
+  /** The regions the check runs from, or `null` when none are set. */
   locations: string[] | null;
+  /** Tags attached to the check. */
   tags: string[];
+  /** Whether a status of 400 or above counts as passing. */
   shouldFail: boolean;
+  /** The request the check sends. */
   request: ApiCheckRequest;
+  /** When the check was created, as an ISO timestamp. */
   created_at: string;
+  /** When the check was last updated, as an ISO timestamp, or `null`. */
   updated_at: string | null;
 }
+/** Options for listing checks. */
 interface ListChecksParams {
   /** Case-insensitive partial match on the check name. */
   search?: string;
+  /** The maximum number of checks per page. */
   limit?: number;
+  /** The page to fetch. */
   page?: number;
 }
+/** Creates a Checkly client with `alertChannels`, `checkStatuses` and `checks` groups sharing one REST client. */
 export declare function createChecklyClient(opts: ChecklyClientOptions): {
   alertChannels: {
     list: () => Promise<AlertChannel[]>;
@@ -195,5 +249,6 @@ export declare function createChecklyClient(opts: ChecklyClientOptions): {
     delete: (id: string) => Promise<void>;
   };
 };
+/** The client `createChecklyClient` returns. */
 export type ChecklyClient = ReturnType<typeof createChecklyClient>;
 export type { AlertChannel, AlertChannelInput, AlertChannelSubscription, AlertChannelType, ApiCheck, ApiCheckInput, ApiCheckRequest, Assertion, AssertionComparison, AssertionSource, CheckStatus, ChecklyClientOptions, HttpMethod, ListChecksParams, WebhookConfig, WebhookKeyValue, WebhookMethod, WebhookType };

package/dist/index.mjs

@@ -167,6 +167,7 @@ function createChecklyRestClient(opts) {
 	});
 }
 // src/index.ts
+/** Creates a Checkly client with `alertChannels`, `checkStatuses` and `checks` groups sharing one REST client. */
 function createChecklyClient(opts) {
 	const rest = createChecklyRestClient(opts);
 	return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/checkly-client",
-  "version": "1.58.0-alpha.2",
+  "version": "1.58.0-alpha.4",
   "description": "A TypeScript client for the Checkly monitoring API",
   "keywords": [
     "checkly",
@@ -33,8 +33,8 @@
     "dist"
   ],
   "dependencies": {
-    "@theholocron/observability": "^0.6.1-alpha.1",
-    "@theholocron/http-client": "^1.58.0-alpha.2"
+    "@theholocron/http-client": "^1.58.0-alpha.4",
+    "@theholocron/observability": "^0.6.1-alpha.1"
   },
   "devDependencies": {
     "@types/node": "^26",
@@ -46,10 +46,10 @@
     "tsdown": "^0.23.3",
     "typescript": "^5.9.3",
     "vitest": "^5.0.5",
-    "@theholocron/eslint-config": "^8.9.0-alpha.3",
-    "@theholocron/tsconfig": "^8.9.0-alpha.3",
-    "@theholocron/tsdown-config": "^8.9.0-alpha.3",
-    "@theholocron/vitest-config": "^8.9.0-alpha.3"
+    "@theholocron/eslint-config": "^8.9.0-alpha.5",
+    "@theholocron/tsdown-config": "^8.9.0-alpha.5",
+    "@theholocron/vitest-config": "^8.9.0-alpha.5",
+    "@theholocron/tsconfig": "^8.9.0-alpha.5"
   },
   "engines": {
     "node": ">=22.0.0"