watchfor 0.18.0 → 0.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.
- package/README.md +4 -3
- package/dist/schema.d.ts +54 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# watchfor
|
|
2
2
|
|
|
3
3
|
Official TypeScript SDK + CLI for [WatchFor](https://watchfor.io) —
|
|
4
|
-
uptime & infrastructure monitoring (
|
|
4
|
+
uptime & infrastructure monitoring (31 check types, confirmed alerting,
|
|
5
5
|
status pages, on-call).
|
|
6
6
|
|
|
7
7
|
```bash
|
|
@@ -94,7 +94,7 @@ await wf.statusPages.updateAnnouncement("<page-id>", notice.id!, {
|
|
|
94
94
|
|
|
95
95
|
### Live diagnostics
|
|
96
96
|
|
|
97
|
-
Run any of
|
|
97
|
+
Run any of 26 checks from WatchFor's probe fleet against **any public
|
|
98
98
|
target**, monitored or not — this measures right now, rather than reading
|
|
99
99
|
what WatchFor recorded:
|
|
100
100
|
|
|
@@ -113,7 +113,8 @@ if (!dns.success) console.log("finding:", dns.error);
|
|
|
113
113
|
console.log("runs left this hour:", dns.remaining);
|
|
114
114
|
|
|
115
115
|
// Graded checks (tls-grade, http-headers, cwv-check, mcp-check, email-health,
|
|
116
|
-
// mail-server-check, cdn-check, smart-audit, dns-health
|
|
116
|
+
// mail-server-check, cdn-check, smart-audit, dns-health, php-version-checker,
|
|
117
|
+
// software-exposure-checker) also return the
|
|
117
118
|
// dashboard's WatchFor Grade: letter, rubric id and what holds it down.
|
|
118
119
|
const headers = await wf.diagnostics.run("http-headers", {
|
|
119
120
|
target: "https://example.com",
|
package/dist/schema.d.ts
CHANGED
|
@@ -1830,6 +1830,37 @@ export interface components {
|
|
|
1830
1830
|
dmarc_pass: boolean | null;
|
|
1831
1831
|
spam_score: number | null;
|
|
1832
1832
|
};
|
|
1833
|
+
/** @description game monitors — the latest check: what the server's status query reported. Player counts are null when the server hides them. */
|
|
1834
|
+
MonitorLatestGame: {
|
|
1835
|
+
/**
|
|
1836
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1837
|
+
* @enum {string}
|
|
1838
|
+
*/
|
|
1839
|
+
kind: "game";
|
|
1840
|
+
/**
|
|
1841
|
+
* Format: date-time
|
|
1842
|
+
* @description When the check this block describes ran.
|
|
1843
|
+
*/
|
|
1844
|
+
checked_at: string | null;
|
|
1845
|
+
/** @description The server answered its status query and the reply parsed. */
|
|
1846
|
+
online: boolean | null;
|
|
1847
|
+
/** @description Status query round trip from the probe location. */
|
|
1848
|
+
query_ping_ms: number | null;
|
|
1849
|
+
players: number | null;
|
|
1850
|
+
max_players: number | null;
|
|
1851
|
+
/** @description Steam (A2S) servers; 0 elsewhere. */
|
|
1852
|
+
bots: number | null;
|
|
1853
|
+
password: boolean | null;
|
|
1854
|
+
/** @description Steam (A2S) servers only. */
|
|
1855
|
+
vac: boolean | null;
|
|
1856
|
+
map: string | null;
|
|
1857
|
+
version: string | null;
|
|
1858
|
+
server_name: string | null;
|
|
1859
|
+
/** @description The game as the server names it. */
|
|
1860
|
+
game: string | null;
|
|
1861
|
+
/** @description The monitor's config.preset. */
|
|
1862
|
+
preset: string | null;
|
|
1863
|
+
};
|
|
1833
1864
|
/** @description Type-aware summary of the monitor page's top cards. `kind` is always the monitor's type; every field is present, null when unknown. */
|
|
1834
1865
|
MonitorLatest:
|
|
1835
1866
|
| components["schemas"]["MonitorLatestSsl"]
|
|
@@ -1861,7 +1892,8 @@ export interface components {
|
|
|
1861
1892
|
| components["schemas"]["MonitorLatestPop3"]
|
|
1862
1893
|
| components["schemas"]["MonitorLatestFtp"]
|
|
1863
1894
|
| components["schemas"]["MonitorLatestSftp"]
|
|
1864
|
-
| components["schemas"]["MonitorLatestEmailRoundtrip"]
|
|
1895
|
+
| components["schemas"]["MonitorLatestEmailRoundtrip"]
|
|
1896
|
+
| components["schemas"]["MonitorLatestGame"];
|
|
1865
1897
|
PlaywrightTestRunRequest: {
|
|
1866
1898
|
/** @description A Playwright Test file (TypeScript or JavaScript). Imports: @playwright/test, otpauth, @faker-js/faker, Node built-ins. Read org variables as process.env.NAME; TARGET_URL is `target`. */
|
|
1867
1899
|
script: string;
|
|
@@ -2119,6 +2151,8 @@ export interface components {
|
|
|
2119
2151
|
| "tls-grade"
|
|
2120
2152
|
| "mcp-check"
|
|
2121
2153
|
| "http-headers"
|
|
2154
|
+
| "php-version-checker"
|
|
2155
|
+
| "software-exposure-checker"
|
|
2122
2156
|
| "api-tester"
|
|
2123
2157
|
| "cdn-check"
|
|
2124
2158
|
| "sitemap-check"
|
|
@@ -2211,6 +2245,8 @@ export interface components {
|
|
|
2211
2245
|
| "tls-grade"
|
|
2212
2246
|
| "mcp-check"
|
|
2213
2247
|
| "http-headers"
|
|
2248
|
+
| "php-version-checker"
|
|
2249
|
+
| "software-exposure-checker"
|
|
2214
2250
|
| "api-tester"
|
|
2215
2251
|
| "cdn-check"
|
|
2216
2252
|
| "sitemap-check"
|
|
@@ -2232,7 +2268,7 @@ export interface components {
|
|
|
2232
2268
|
timed_out?: boolean;
|
|
2233
2269
|
/** @description The probe's raw result — shape depends on the check (response, metrics, error). Composite checks return their aggregate here. */
|
|
2234
2270
|
result: unknown;
|
|
2235
|
-
/** @description Graded checks only (tls-grade, http-headers,
|
|
2271
|
+
/** @description Graded checks only (smart-audit, cwv-check, tls-grade, mcp-check, http-headers, cdn-check, mail-server-check, email-health with variant all, dns-health, php-version-checker, software-exposure-checker): the dashboard's letter with the findings that set it. Omitted for other checks. */
|
|
2236
2272
|
grade?: components["schemas"]["WatchForGrade"];
|
|
2237
2273
|
/** @description Runs left for this check in the current window; null = unlimited. Pace long investigations by this. */
|
|
2238
2274
|
remaining: number | null;
|
|
@@ -2260,6 +2296,8 @@ export interface components {
|
|
|
2260
2296
|
| "tls-grade"
|
|
2261
2297
|
| "mcp-check"
|
|
2262
2298
|
| "http-headers"
|
|
2299
|
+
| "php-version-checker"
|
|
2300
|
+
| "software-exposure-checker"
|
|
2263
2301
|
| "api-tester"
|
|
2264
2302
|
| "cdn-check"
|
|
2265
2303
|
| "sitemap-check"
|
|
@@ -2398,7 +2436,8 @@ export interface components {
|
|
|
2398
2436
|
| "playwright"
|
|
2399
2437
|
| "imap"
|
|
2400
2438
|
| "pop3"
|
|
2401
|
-
| "email_roundtrip"
|
|
2439
|
+
| "email_roundtrip"
|
|
2440
|
+
| "game";
|
|
2402
2441
|
target?: string;
|
|
2403
2442
|
description?: string | null;
|
|
2404
2443
|
interval_seconds?: number;
|
|
@@ -2567,7 +2606,8 @@ export interface components {
|
|
|
2567
2606
|
| "playwright"
|
|
2568
2607
|
| "imap"
|
|
2569
2608
|
| "pop3"
|
|
2570
|
-
| "email_roundtrip"
|
|
2609
|
+
| "email_roundtrip"
|
|
2610
|
+
| "game";
|
|
2571
2611
|
/** @description Format per type (see GET /meta/monitor-types). Targets in private, loopback, link-local or cloud-metadata address space (and internal hostnames such as localhost, *.internal) are rejected with 400. heartbeat: the server assigns the ping path — send any placeholder (or omit target); read ping_url from the response. smtp: hostname only, the port goes in config.port. */
|
|
2572
2612
|
target: string;
|
|
2573
2613
|
/** @description Seconds; validated against the plan's per-type minimum */
|
|
@@ -3818,7 +3858,8 @@ export interface components {
|
|
|
3818
3858
|
| "playwright"
|
|
3819
3859
|
| "imap"
|
|
3820
3860
|
| "pop3"
|
|
3821
|
-
| "email_roundtrip"
|
|
3861
|
+
| "email_roundtrip"
|
|
3862
|
+
| "game";
|
|
3822
3863
|
label?: string;
|
|
3823
3864
|
description?: string;
|
|
3824
3865
|
target_format?: string;
|
|
@@ -4354,6 +4395,10 @@ export interface components {
|
|
|
4354
4395
|
/** @default true */
|
|
4355
4396
|
followRedirects: boolean;
|
|
4356
4397
|
};
|
|
4398
|
+
/** @description Options for the `php-version-checker` diagnostic. Which PHP version does this site announce (X-Powered-By, Server), is it vulnerable to php2shell (CVE-2026-109618/109619) or other known CVEs, and is its branch past end of life — graded A+…F? */
|
|
4399
|
+
DiagnosticOptionsPhpVersionChecker: Record<string, never>;
|
|
4400
|
+
/** @description Options for the `software-exposure-checker` diagnostic. Which software versions does this page reveal in its headers and HTML — web server, PHP, CMS, JavaScript libraries — and which are outdated, past end of life or have known CVEs, graded A+…F? */
|
|
4401
|
+
DiagnosticOptionsSoftwareExposureChecker: Record<string, never>;
|
|
4357
4402
|
/** @description Options for the `api-tester` diagnostic. What does this API endpoint answer to a full request (method, headers, body) — status, headers and the complete response body? */
|
|
4358
4403
|
DiagnosticOptionsApiTester: {
|
|
4359
4404
|
/**
|
|
@@ -4663,6 +4708,7 @@ export interface operations {
|
|
|
4663
4708
|
query?: never;
|
|
4664
4709
|
header?: never;
|
|
4665
4710
|
path: {
|
|
4711
|
+
/** @description Shell-style name. Names the browser runtime reserves are refused on PUT with 400 (they can still be deleted): PATH, HOME, TMPDIR, CI, DEBUG, FORCE_COLOR, NO_COLOR, HTTP_PROXY, HTTPS_PROXY, NO_PROXY, ALL_PROXY and anything starting with NODE_, PLAYWRIGHT_, PW_, WF_, LD_, UV_ or SSL_. */
|
|
4666
4712
|
name: string;
|
|
4667
4713
|
};
|
|
4668
4714
|
cookie?: never;
|
|
@@ -4707,6 +4753,7 @@ export interface operations {
|
|
|
4707
4753
|
query?: never;
|
|
4708
4754
|
header?: never;
|
|
4709
4755
|
path: {
|
|
4756
|
+
/** @description Shell-style name. Names the browser runtime reserves are refused on PUT with 400 (they can still be deleted): PATH, HOME, TMPDIR, CI, DEBUG, FORCE_COLOR, NO_COLOR, HTTP_PROXY, HTTPS_PROXY, NO_PROXY, ALL_PROXY and anything starting with NODE_, PLAYWRIGHT_, PW_, WF_, LD_, UV_ or SSL_. */
|
|
4710
4757
|
name: string;
|
|
4711
4758
|
};
|
|
4712
4759
|
cookie?: never;
|
|
@@ -4786,6 +4833,8 @@ export interface operations {
|
|
|
4786
4833
|
| "tls-grade"
|
|
4787
4834
|
| "mcp-check"
|
|
4788
4835
|
| "http-headers"
|
|
4836
|
+
| "php-version-checker"
|
|
4837
|
+
| "software-exposure-checker"
|
|
4789
4838
|
| "api-tester"
|
|
4790
4839
|
| "cdn-check"
|
|
4791
4840
|
| "sitemap-check"
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "watchfor",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.20.0",
|
|
4
4
|
"description": "Official TypeScript SDK + CLI for WatchFor — uptime & infrastructure monitoring (monitors, alert rules, incidents, maintenance windows) over the REST API.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"watchfor",
|