@theholocron/checkly-client 1.40.0 → 1.42.0

package/README.md

@@ -21,11 +21,16 @@ const checkly = createChecklyClient({
 // Find an existing check by name (case-insensitive partial match)
 const existing = await checkly.checks.list({ search: "sentinel webhook" });
 
-// Create an API check
+// Create an API check. shouldFail: true is required whenever the
+// "healthy" response is itself an HTTP error status (here, a 405) --
+// without it, Checkly's platform-level retry/failure classification
+// treats any 4xx/5xx as a failure before your assertions are even
+// evaluated, regardless of whether they match.
 const check = await checkly.checks.create({
   name: "Sentinel webhook uptime",
   frequency: 5,
   locations: ["us-east-1"],
+  shouldFail: true,
   request: {
     url: "https://sentinel.theholocron.dev/api/webhook",
     method: "GET",
@@ -40,6 +45,22 @@ await checkly.checks.update(check.id, {
   request: check.request,
 });
 
+// A second check with a request body -- e.g. to verify the endpoint's own
+// signature checking, not just that it's reachable. request.body is sent
+// as-is; the client sets Checkly's own bodyType to "RAW" whenever a body
+// is given.
+const signatureCheck = await checkly.checks.create({
+  name: "Sentinel webhook signature verification",
+  locations: ["us-east-1"],
+  shouldFail: true,
+  request: {
+    url: "https://sentinel.theholocron.dev/api/webhook",
+    method: "POST",
+    body: "{}",
+    assertions: [{ source: "STATUS_CODE", comparison: "EQUALS", target: "401" }],
+  },
+});
+
 // Delete it
 await checkly.checks.delete(check.id);
 ```

package/dist/index.d.mts

@@ -32,6 +32,14 @@ interface ApiCheckRequest {
   url: string;
   method: HttpMethod;
   assertions?: Assertion[];
+  /**
+   * Raw request body to send with the check — e.g. simulating a webhook
+   * delivery to verify signature checking is wired correctly end-to-end,
+   * as opposed to just the endpoint being reachable. Omitted entirely by
+   * default, leaving Checkly's own `bodyType` at `"NONE"`; `create()`/
+   * `update()` set it to `"RAW"` whenever a body is given.
+   */
+  body?: string;
 }
 interface ApiCheckInput {
   name: string;
@@ -41,6 +49,17 @@ interface ApiCheckInput {
   locations?: string[];
   activated?: boolean;
   tags?: string[];
+  /**
+   * Inverts pass/fail: when `true`, a response status >= 400 counts as
+   * passing (and a < 400 status fails) *before* assertions are even
+   * evaluated. Required for any check whose "healthy" response is
+   * itself an HTTP error status (e.g. asserting a 404/405 on an
+   * endpoint that should reject certain requests) — without it,
+   * Checkly's platform-level retry/failure classification treats any
+   * 4xx/5xx as a failure regardless of matching assertions. Defaults
+   * to `false`.
+   */
+  shouldFail?: boolean;
   request: ApiCheckRequest;
 }
 interface ApiCheck {
@@ -51,6 +70,7 @@ interface ApiCheck {
   frequency: number;
   locations: string[] | null;
   tags: string[];
+  shouldFail: boolean;
   request: ApiCheckRequest;
   created_at: string;
   updated_at: string | null;

package/dist/index.mjs

@@ -1,5 +1,24 @@
 import { createRestClient } from "@theholocron/http-client";
 //#region ../../../../../src/checks/checks.ts
+/**
+* `ApiCheckInput.request.body` is holocron's simplified shape (just the raw
+* string); Checkly's wire format pairs it with a `bodyType` discriminator.
+* `"RAW"` whenever a body is given — the only body shape this client
+* exposes today — otherwise left unset, so Checkly's own `"NONE"` default
+* stands.
+*/
+function toWirePayload(input) {
+	return {
+		...input,
+		request: {
+			...input.request,
+			...input.request.body !== void 0 ? {
+				body: input.request.body,
+				bodyType: "RAW"
+			} : {}
+		}
+	};
+}
 function checks(rest) {
 	return {
 		/** List checks, optionally filtered by a case-insensitive partial name match. */
@@ -13,12 +32,12 @@ function checks(rest) {
 		/** Create a new API check. */
 		create: (input) => rest.request("/checks/api", {
 			method: "POST",
-			body: input
+			body: toWirePayload(input)
 		}),
 		/** Update an existing API check. */
 		update: (id, input) => rest.request(`/checks/api/${id}`, {
 			method: "PUT",
-			body: input
+			body: toWirePayload(input)
 		}),
 		/** Delete a check (any type) by id. */
 		delete: (id) => rest.request(`/checks/${id}`, { method: "DELETE" })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/checkly-client",
-  "version": "1.40.0",
+  "version": "1.42.0",
   "description": "A TypeScript client for the Checkly monitoring API",
   "keywords": [
     "checkly",
@@ -34,7 +34,7 @@
   ],
   "dependencies": {
     "@theholocron/observability": "^0.3.0",
-    "@theholocron/http-client": "^1.40.0"
+    "@theholocron/http-client": "^1.42.0"
   },
   "devDependencies": {
     "@theholocron/cli": "5.0.0-alpha.79",