@theholocron/checkly-client 1.54.2 → 1.56.0

package/README.md

@@ -65,6 +65,14 @@ const signatureCheck = await checkly.checks.create({
 await checkly.checks.delete(check.id);
 ```
 
+## Check status
+
+```ts
+// Has the latest run failed? A check that has not run yet has no status (404) or no `lastCheckRunId`.
+const status = await checkly.checkStatuses.get(check.id);
+if (status.lastCheckRunId && status.hasFailures) console.log("failing");
+```
+
 ## Auth
 
 Generate an [API key](https://www.checklyhq.com/docs/accounts-and-users/creating-api-key/)

package/dist/index.d.mts

@@ -100,6 +100,26 @@ type AlertChannel = AlertChannelRecord & ({
  */
 declare const DISCORD_TEMPLATE = "{\n\t\"content\": null,\n\t\"username\": \"Checkly\",\n\t\"avatar_url\": \"https://s3.eu-central-1.amazonaws.com/cdn.checklyhq.com/slack/checkly-slack-icon.png\",\n\t{{! Embeds for the SSL expiry notifications}}\n\t{{#eq ALERT_TYPE \"ALERT_SSL\" }}\n\t\"embeds\": [\n\t\t{\n\t\t\t\"title\": \"{{ALERT_TITLE}}\",\n\t\t\t\"url\": \"{{RESULT_LINK}}\",\n\t\t\t\"color\": 16762924\n\t\t}\n\t]\n\t{{else}}\n\t{{! Embeds for the standard failure, recovery and degraded notifications}}\n\t\"embeds\": [\n\t\t{\n\t\t\t\"title\": \"{{ALERT_TITLE}}\",\n\t\t\t\"url\": \"{{RESULT_LINK}}\",\n\t\t\t{{! Green for a recovery, red for a failure, amber for anything degraded}}\n\t\t\t\"color\": {{#eq ALERT_TYPE \"ALERT_RECOVERY\"}}3187820{{else}}{{#eq ALERT_TYPE \"ALERT_DEGRADED_RECOVERY\"}}3187820{{else}}{{#eq ALERT_TYPE \"ALERT_FAILURE\"}}15033421{{else}}16098596{{/eq}}{{/eq}}{{/eq}},\n\t\t\t\"fields\": [\n\t\t\t\t{{#eq CHECK_TYPE \"API\" }}\n\t\t\t\t{\n\t\t\t\t\t\"name\": \"Status code\",\n\t\t\t\t\t\"value\": \"{{API_CHECK_RESPONSE_STATUS_CODE}}\"\n\t\t\t\t},\n\t\t\t\t{{/eq}}\n\t\t\t\t{{#if GROUP_NAME}}\n\t\t\t\t{\n\t\t\t\t\t\"name\": \"Group\",\n\t\t\t\t\t\"value\": \"{{GROUP_NAME}}\"\n\t\t\t\t},\n\t\t\t\t{{/if}}\n\t\t\t\t{\n\t\t\t\t\t\"name\": \"Response Time\",\n\t\t\t\t\t\"value\": \"{{RESPONSE_TIME}}ms\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"name\": \"Location\",\n\t\t\t\t\t\"value\": \"{{RUN_LOCATION}}\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"name\": \"Tags\",\n\t\t\t\t\t\"value\": \"[{{#each TAGS}} {{this}} {{#unless @last}},{{/unless}} {{/each}}]\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"timestamp\": \"{{STARTED_AT}}\"\n\t\t}\n\t]\n\t{{/eq}}\n}\n";
 //#endregion
+//#region ../../../../../src/check-statuses/check-statuses.d.ts
+/**
+ * Where a check stands after its latest run, from `GET /v1/check-statuses/{checkId}`. A check that has not run yet has
+ * no run id, and Checkly may answer 404 for it, so callers wait for `lastCheckRunId` before trusting the flags.
+ */
+interface CheckStatus {
+  checkId: string;
+  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;
+  isDegraded?: boolean;
+  /** Null or absent until the check has run. */
+  lastCheckRunId?: string | null;
+  lastRunLocation?: string | null;
+  created_at?: string;
+  updated_at?: string | null;
+}
+//#endregion
 //#region ../../../../../src/checks/checks.d.ts
 type AssertionSource = "STATUS_CODE" | "JSON_BODY" | "HEADERS" | "TEXT_BODY" | "RESPONSE_TIME";
 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";
@@ -176,6 +196,9 @@ declare function createChecklyClient(opts: ChecklyClientOptions): {
     subscribe: (id: number, subscription: AlertChannelSubscription) => Promise<AlertChannelSubscription>;
     delete: (id: number) => Promise<void>;
   };
+  checkStatuses: {
+    get: (checkId: string) => Promise<CheckStatus>;
+  };
   checks: {
     list: (params?: ListChecksParams) => Promise<ApiCheck[]>;
     get: (id: string) => Promise<ApiCheck>;
@@ -186,4 +209,4 @@ declare function createChecklyClient(opts: ChecklyClientOptions): {
 };
 type ChecklyClient = ReturnType<typeof createChecklyClient>;
 //#endregion
-export { type AlertChannel, type AlertChannelInput, type AlertChannelSubscription, type AlertChannelType, type ApiCheck, type ApiCheckInput, type ApiCheckRequest, type Assertion, type AssertionComparison, type AssertionSource, ChecklyClient, type ChecklyClientOptions, DISCORD_TEMPLATE, type HttpMethod, type ListChecksParams, type WebhookConfig, type WebhookKeyValue, type WebhookMethod, type WebhookType, createChecklyClient };
+export { type AlertChannel, type AlertChannelInput, type AlertChannelSubscription, type AlertChannelType, type ApiCheck, type ApiCheckInput, type ApiCheckRequest, type Assertion, type AssertionComparison, type AssertionSource, type CheckStatus, ChecklyClient, type ChecklyClientOptions, DISCORD_TEMPLATE, type HttpMethod, type ListChecksParams, type WebhookConfig, type WebhookKeyValue, type WebhookMethod, type WebhookType, createChecklyClient };

package/dist/index.mjs

@@ -105,6 +105,13 @@ function alertChannels(rest) {
 	};
 }
 //#endregion
+//#region ../../../../../src/check-statuses/check-statuses.ts
+function checkStatuses(rest) {
+	return { 
+	/** The latest status of one check. Throws ProviderApiError 404 if Checkly has none yet (the check has not run). */
+get: (checkId) => rest.request(`/check-statuses/${encodeURIComponent(checkId)}`) };
+}
+//#endregion
 //#region ../../../../../src/checks/checks.ts
 /**
 * `ApiCheckInput.request.body` is holocron's simplified shape (just the raw
@@ -168,6 +175,7 @@ function createChecklyClient(opts) {
 	const rest = createChecklyRestClient(opts);
 	return {
 		alertChannels: alertChannels(rest),
+		checkStatuses: checkStatuses(rest),
 		checks: checks(rest)
 	};
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/checkly-client",
-  "version": "1.54.2",
+  "version": "1.56.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.54.2"
+    "@theholocron/http-client": "^1.56.0"
   },
   "devDependencies": {
     "@theholocron/cli": "5.0.0-alpha.79",