watchfor 0.17.0 → 0.17.1
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/dist/schema.d.ts +656 -29
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -1165,6 +1165,660 @@ export interface paths {
|
|
|
1165
1165
|
export type webhooks = Record<string, never>;
|
|
1166
1166
|
export interface components {
|
|
1167
1167
|
schemas: {
|
|
1168
|
+
/** @description ssl monitors — the certificate card. `protocol`/`cipher_suite` are the negotiated connection's. */
|
|
1169
|
+
MonitorLatestSsl: {
|
|
1170
|
+
/**
|
|
1171
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1172
|
+
* @enum {string}
|
|
1173
|
+
*/
|
|
1174
|
+
kind: "ssl";
|
|
1175
|
+
/**
|
|
1176
|
+
* Format: date-time
|
|
1177
|
+
* @description When the check this block describes ran.
|
|
1178
|
+
*/
|
|
1179
|
+
checked_at: string | null;
|
|
1180
|
+
days_until_expiry: number | null;
|
|
1181
|
+
/** Format: date-time */
|
|
1182
|
+
not_after: string | null;
|
|
1183
|
+
/** @description Issuer organisation, else its common name. */
|
|
1184
|
+
issuer: string | null;
|
|
1185
|
+
/** @description e.g. "TLS 1.3". */
|
|
1186
|
+
protocol: string | null;
|
|
1187
|
+
valid: boolean | null;
|
|
1188
|
+
hostname_match: boolean | null;
|
|
1189
|
+
chain_valid: boolean | null;
|
|
1190
|
+
subject: string | null;
|
|
1191
|
+
/** @description Subject alternative names. */
|
|
1192
|
+
sans: string[] | null;
|
|
1193
|
+
cipher_suite: string | null;
|
|
1194
|
+
forward_secrecy: boolean | null;
|
|
1195
|
+
/** @description Daily TLS grade (A+ … F) when the monitor opts into grading; from the latest graded check. */
|
|
1196
|
+
tls_grade: string | null;
|
|
1197
|
+
/**
|
|
1198
|
+
* Format: date-time
|
|
1199
|
+
* @description When that grade was measured.
|
|
1200
|
+
*/
|
|
1201
|
+
tls_graded_at: string | null;
|
|
1202
|
+
};
|
|
1203
|
+
/** @description rdap (domain) monitors — the registration card. Expiry fields come from the latest check that found an expiry (an expired domain included); registrar, status and dates from the latest check that returned them. */
|
|
1204
|
+
MonitorLatestRdap: {
|
|
1205
|
+
/**
|
|
1206
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1207
|
+
* @enum {string}
|
|
1208
|
+
*/
|
|
1209
|
+
kind: "rdap";
|
|
1210
|
+
/**
|
|
1211
|
+
* Format: date-time
|
|
1212
|
+
* @description When the check this block describes ran.
|
|
1213
|
+
*/
|
|
1214
|
+
checked_at: string | null;
|
|
1215
|
+
/** Format: date-time */
|
|
1216
|
+
expires_at: string | null;
|
|
1217
|
+
/** @description Negative once the domain has expired. */
|
|
1218
|
+
days_until_expiry: number | null;
|
|
1219
|
+
registrar: string | null;
|
|
1220
|
+
nameservers: string[];
|
|
1221
|
+
/** @description RDAP/EPP status codes, e.g. "client transfer prohibited". */
|
|
1222
|
+
status: string[];
|
|
1223
|
+
/** @description Registration date — ISO 8601 when parseable, else as the registry reports it. */
|
|
1224
|
+
created_date: string | null;
|
|
1225
|
+
/** @description Last registry update — ISO 8601 when parseable, else as reported. */
|
|
1226
|
+
updated_date: string | null;
|
|
1227
|
+
/** @description The expiry came from the prober's lookup cache rather than a fresh registry query. */
|
|
1228
|
+
cached: boolean | null;
|
|
1229
|
+
};
|
|
1230
|
+
/** @description heartbeat monitors — the last-ping card. */
|
|
1231
|
+
MonitorLatestHeartbeat: {
|
|
1232
|
+
/**
|
|
1233
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1234
|
+
* @enum {string}
|
|
1235
|
+
*/
|
|
1236
|
+
kind: "heartbeat";
|
|
1237
|
+
/**
|
|
1238
|
+
* Format: date-time
|
|
1239
|
+
* @description The latest heartbeat event of any kind (ping, start or miss).
|
|
1240
|
+
*/
|
|
1241
|
+
checked_at: string | null;
|
|
1242
|
+
/**
|
|
1243
|
+
* Format: date-time
|
|
1244
|
+
* @description Last finish/plain ping (starts and scheduler-fired misses do not count).
|
|
1245
|
+
*/
|
|
1246
|
+
last_ping_at: string | null;
|
|
1247
|
+
/**
|
|
1248
|
+
* Format: date-time
|
|
1249
|
+
* @description Period schedules only; null for cron.
|
|
1250
|
+
*/
|
|
1251
|
+
next_expected_at: string | null;
|
|
1252
|
+
missed: boolean;
|
|
1253
|
+
last_exit_code: number | null;
|
|
1254
|
+
};
|
|
1255
|
+
/** @description http monitors — the latest check. */
|
|
1256
|
+
MonitorLatestHttp: {
|
|
1257
|
+
/**
|
|
1258
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1259
|
+
* @enum {string}
|
|
1260
|
+
*/
|
|
1261
|
+
kind: "http";
|
|
1262
|
+
/**
|
|
1263
|
+
* Format: date-time
|
|
1264
|
+
* @description When the check this block describes ran.
|
|
1265
|
+
*/
|
|
1266
|
+
checked_at: string | null;
|
|
1267
|
+
status_code: number | null;
|
|
1268
|
+
ttfb_ms: number | null;
|
|
1269
|
+
redirects_count: number | null;
|
|
1270
|
+
/** @description Days until the certificate the latest check saw expires; null when it saw none (plain text, or failed before TLS). */
|
|
1271
|
+
cert_days_left: number | null;
|
|
1272
|
+
};
|
|
1273
|
+
/** @description api monitors — the latest check. */
|
|
1274
|
+
MonitorLatestApi: {
|
|
1275
|
+
/**
|
|
1276
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1277
|
+
* @enum {string}
|
|
1278
|
+
*/
|
|
1279
|
+
kind: "api";
|
|
1280
|
+
/**
|
|
1281
|
+
* Format: date-time
|
|
1282
|
+
* @description When the check this block describes ran.
|
|
1283
|
+
*/
|
|
1284
|
+
checked_at: string | null;
|
|
1285
|
+
status_code: number | null;
|
|
1286
|
+
response_time_ms: number | null;
|
|
1287
|
+
/** @description Days until the certificate the latest check saw expires; null when it saw none (plain text, or failed before TLS). */
|
|
1288
|
+
cert_days_left: number | null;
|
|
1289
|
+
assertions_total: number | null;
|
|
1290
|
+
assertions_failed: number | null;
|
|
1291
|
+
/** @description The latest check's failing assertions (at most 20), redacted like check payloads. */
|
|
1292
|
+
failed_assertions: {
|
|
1293
|
+
source: string | null;
|
|
1294
|
+
property: string | null;
|
|
1295
|
+
operator: string | null;
|
|
1296
|
+
expected: string | null;
|
|
1297
|
+
actual: string | null;
|
|
1298
|
+
error: string | null;
|
|
1299
|
+
}[];
|
|
1300
|
+
};
|
|
1301
|
+
/** @description tcp monitors — the latest check. */
|
|
1302
|
+
MonitorLatestTcp: {
|
|
1303
|
+
/**
|
|
1304
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1305
|
+
* @enum {string}
|
|
1306
|
+
*/
|
|
1307
|
+
kind: "tcp";
|
|
1308
|
+
/**
|
|
1309
|
+
* Format: date-time
|
|
1310
|
+
* @description When the check this block describes ran.
|
|
1311
|
+
*/
|
|
1312
|
+
checked_at: string | null;
|
|
1313
|
+
connect_ms: number | null;
|
|
1314
|
+
/** @description null without TLS. */
|
|
1315
|
+
tls_handshake_ms: number | null;
|
|
1316
|
+
/** @description Days until the certificate the latest check saw expires; null when it saw none (plain text, or failed before TLS). */
|
|
1317
|
+
cert_days_left: number | null;
|
|
1318
|
+
};
|
|
1319
|
+
/** @description udp monitors — the latest check. */
|
|
1320
|
+
MonitorLatestUdp: {
|
|
1321
|
+
/**
|
|
1322
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1323
|
+
* @enum {string}
|
|
1324
|
+
*/
|
|
1325
|
+
kind: "udp";
|
|
1326
|
+
/**
|
|
1327
|
+
* Format: date-time
|
|
1328
|
+
* @description When the check this block describes ran.
|
|
1329
|
+
*/
|
|
1330
|
+
checked_at: string | null;
|
|
1331
|
+
response_received: boolean | null;
|
|
1332
|
+
bytes_received: number | null;
|
|
1333
|
+
first_byte_ms: number | null;
|
|
1334
|
+
};
|
|
1335
|
+
/** @description icmp (ping) monitors — the latest check. RTTs are null when no reply came back. */
|
|
1336
|
+
MonitorLatestIcmp: {
|
|
1337
|
+
/**
|
|
1338
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1339
|
+
* @enum {string}
|
|
1340
|
+
*/
|
|
1341
|
+
kind: "icmp";
|
|
1342
|
+
/**
|
|
1343
|
+
* Format: date-time
|
|
1344
|
+
* @description When the check this block describes ran.
|
|
1345
|
+
*/
|
|
1346
|
+
checked_at: string | null;
|
|
1347
|
+
rtt_avg_ms: number | null;
|
|
1348
|
+
rtt_min_ms: number | null;
|
|
1349
|
+
rtt_max_ms: number | null;
|
|
1350
|
+
jitter_ms: number | null;
|
|
1351
|
+
packet_loss_pct: number | null;
|
|
1352
|
+
packets_sent: number | null;
|
|
1353
|
+
packets_received: number | null;
|
|
1354
|
+
};
|
|
1355
|
+
/** @description dns monitors — the latest check. */
|
|
1356
|
+
MonitorLatestDns: {
|
|
1357
|
+
/**
|
|
1358
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1359
|
+
* @enum {string}
|
|
1360
|
+
*/
|
|
1361
|
+
kind: "dns";
|
|
1362
|
+
/**
|
|
1363
|
+
* Format: date-time
|
|
1364
|
+
* @description When the check this block describes ran.
|
|
1365
|
+
*/
|
|
1366
|
+
checked_at: string | null;
|
|
1367
|
+
query_type: string | null;
|
|
1368
|
+
/** @description e.g. "NOERROR", "NXDOMAIN". */
|
|
1369
|
+
rcode: string | null;
|
|
1370
|
+
answers_count: number | null;
|
|
1371
|
+
lookup_ms: number | null;
|
|
1372
|
+
};
|
|
1373
|
+
/** @description smtp monitors — the latest check. */
|
|
1374
|
+
MonitorLatestSmtp: {
|
|
1375
|
+
/**
|
|
1376
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1377
|
+
* @enum {string}
|
|
1378
|
+
*/
|
|
1379
|
+
kind: "smtp";
|
|
1380
|
+
/**
|
|
1381
|
+
* Format: date-time
|
|
1382
|
+
* @description When the check this block describes ran.
|
|
1383
|
+
*/
|
|
1384
|
+
checked_at: string | null;
|
|
1385
|
+
connect_ms: number | null;
|
|
1386
|
+
tls_supported: boolean | null;
|
|
1387
|
+
open_relay: boolean | null;
|
|
1388
|
+
ptr_valid: boolean | null;
|
|
1389
|
+
/** @description Days until the certificate the latest check saw expires; null when it saw none (plain text, or failed before TLS). */
|
|
1390
|
+
cert_days_left: number | null;
|
|
1391
|
+
/** @description null = no username configured. */
|
|
1392
|
+
login_ok: boolean | null;
|
|
1393
|
+
};
|
|
1394
|
+
/** @description sitemap monitors — the latest check. */
|
|
1395
|
+
MonitorLatestSitemap: {
|
|
1396
|
+
/**
|
|
1397
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1398
|
+
* @enum {string}
|
|
1399
|
+
*/
|
|
1400
|
+
kind: "sitemap";
|
|
1401
|
+
/**
|
|
1402
|
+
* Format: date-time
|
|
1403
|
+
* @description When the check this block describes ran.
|
|
1404
|
+
*/
|
|
1405
|
+
checked_at: string | null;
|
|
1406
|
+
found: boolean | null;
|
|
1407
|
+
url_count: number | null;
|
|
1408
|
+
broken_urls: number | null;
|
|
1409
|
+
broken_percent: number | null;
|
|
1410
|
+
};
|
|
1411
|
+
/** @description mtr (traceroute) monitors — the latest check. */
|
|
1412
|
+
MonitorLatestMtr: {
|
|
1413
|
+
/**
|
|
1414
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1415
|
+
* @enum {string}
|
|
1416
|
+
*/
|
|
1417
|
+
kind: "mtr";
|
|
1418
|
+
/**
|
|
1419
|
+
* Format: date-time
|
|
1420
|
+
* @description When the check this block describes ran.
|
|
1421
|
+
*/
|
|
1422
|
+
checked_at: string | null;
|
|
1423
|
+
destination_reached: boolean | null;
|
|
1424
|
+
hops: number | null;
|
|
1425
|
+
visible_hops: number | null;
|
|
1426
|
+
unresponsive_hops: number | null;
|
|
1427
|
+
destination_loss_pct: number | null;
|
|
1428
|
+
path_loss_max_pct: number | null;
|
|
1429
|
+
/** @description Destination round trip; null when not reached. */
|
|
1430
|
+
rtt_avg_ms: number | null;
|
|
1431
|
+
};
|
|
1432
|
+
/** @description ntp monitors — the latest check. Clock figures are null when no sample was valid. */
|
|
1433
|
+
MonitorLatestNtp: {
|
|
1434
|
+
/**
|
|
1435
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1436
|
+
* @enum {string}
|
|
1437
|
+
*/
|
|
1438
|
+
kind: "ntp";
|
|
1439
|
+
/**
|
|
1440
|
+
* Format: date-time
|
|
1441
|
+
* @description When the check this block describes ran.
|
|
1442
|
+
*/
|
|
1443
|
+
checked_at: string | null;
|
|
1444
|
+
/** @description Signed clock offset. */
|
|
1445
|
+
offset_ms: number | null;
|
|
1446
|
+
delay_ms: number | null;
|
|
1447
|
+
jitter_ms: number | null;
|
|
1448
|
+
/** @description 1–15 synced, 16 unsynchronised. */
|
|
1449
|
+
stratum: number | null;
|
|
1450
|
+
synced: boolean | null;
|
|
1451
|
+
/** @description The probe's own verdict against the configured offset/delay limits. */
|
|
1452
|
+
check_passed: boolean | null;
|
|
1453
|
+
};
|
|
1454
|
+
/** @description websocket monitors — the latest check. */
|
|
1455
|
+
MonitorLatestWebsocket: {
|
|
1456
|
+
/**
|
|
1457
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1458
|
+
* @enum {string}
|
|
1459
|
+
*/
|
|
1460
|
+
kind: "websocket";
|
|
1461
|
+
/**
|
|
1462
|
+
* Format: date-time
|
|
1463
|
+
* @description When the check this block describes ran.
|
|
1464
|
+
*/
|
|
1465
|
+
checked_at: string | null;
|
|
1466
|
+
connected: boolean;
|
|
1467
|
+
handshake_ms: number | null;
|
|
1468
|
+
/** @description null when the ping check is off. */
|
|
1469
|
+
ping_rtt_ms: number | null;
|
|
1470
|
+
/** @description null when no expect pattern is configured. */
|
|
1471
|
+
message_matched: boolean | null;
|
|
1472
|
+
};
|
|
1473
|
+
/** @description blacklist (DNSBL) monitors — the latest check. */
|
|
1474
|
+
MonitorLatestBlacklist: {
|
|
1475
|
+
/**
|
|
1476
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1477
|
+
* @enum {string}
|
|
1478
|
+
*/
|
|
1479
|
+
kind: "blacklist";
|
|
1480
|
+
/**
|
|
1481
|
+
* Format: date-time
|
|
1482
|
+
* @description When the check this block describes ran.
|
|
1483
|
+
*/
|
|
1484
|
+
checked_at: string | null;
|
|
1485
|
+
listed_count: number | null;
|
|
1486
|
+
checked_count: number | null;
|
|
1487
|
+
clean_count: number | null;
|
|
1488
|
+
timeout_count: number | null;
|
|
1489
|
+
/** @description Blocklists the target is listed on; null when the check stored no per-list detail. */
|
|
1490
|
+
listed_on: string[] | null;
|
|
1491
|
+
};
|
|
1492
|
+
/** @description breach monitors — the latest lookup. Counts are null when the lookup itself failed. */
|
|
1493
|
+
MonitorLatestBreach: {
|
|
1494
|
+
/**
|
|
1495
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1496
|
+
* @enum {string}
|
|
1497
|
+
*/
|
|
1498
|
+
kind: "breach";
|
|
1499
|
+
/**
|
|
1500
|
+
* Format: date-time
|
|
1501
|
+
* @description When the check this block describes ran.
|
|
1502
|
+
*/
|
|
1503
|
+
checked_at: string | null;
|
|
1504
|
+
/** @description Known breaches of the domain, any age. */
|
|
1505
|
+
breach_count: number | null;
|
|
1506
|
+
/** @description Of those, within the last 2 years. */
|
|
1507
|
+
recent_count: number | null;
|
|
1508
|
+
};
|
|
1509
|
+
/** @description email_policy monitors — SPF / DMARC / DKIM as of the latest check (MTA-STS is not checked). */
|
|
1510
|
+
MonitorLatestEmailPolicy: {
|
|
1511
|
+
/**
|
|
1512
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1513
|
+
* @enum {string}
|
|
1514
|
+
*/
|
|
1515
|
+
kind: "email_policy";
|
|
1516
|
+
/**
|
|
1517
|
+
* Format: date-time
|
|
1518
|
+
* @description When the check this block describes ran.
|
|
1519
|
+
*/
|
|
1520
|
+
checked_at: string | null;
|
|
1521
|
+
spf_present: boolean | null;
|
|
1522
|
+
spf_valid: boolean | null;
|
|
1523
|
+
dmarc_present: boolean | null;
|
|
1524
|
+
dmarc_valid: boolean | null;
|
|
1525
|
+
/**
|
|
1526
|
+
* @description null without a DMARC record.
|
|
1527
|
+
* @enum {string|null}
|
|
1528
|
+
*/
|
|
1529
|
+
dmarc_policy: "none" | "quarantine" | "reject" | null;
|
|
1530
|
+
dkim_present: boolean | null;
|
|
1531
|
+
dkim_valid: boolean | null;
|
|
1532
|
+
};
|
|
1533
|
+
/** @description cdn monitors — the latest check. */
|
|
1534
|
+
MonitorLatestCdn: {
|
|
1535
|
+
/**
|
|
1536
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1537
|
+
* @enum {string}
|
|
1538
|
+
*/
|
|
1539
|
+
kind: "cdn";
|
|
1540
|
+
/**
|
|
1541
|
+
* Format: date-time
|
|
1542
|
+
* @description When the check this block describes ran.
|
|
1543
|
+
*/
|
|
1544
|
+
checked_at: string | null;
|
|
1545
|
+
detected: boolean | null;
|
|
1546
|
+
/** @description e.g. "cloudflare". */
|
|
1547
|
+
provider: string | null;
|
|
1548
|
+
/** @description The edge's own cache verdict, e.g. HIT. */
|
|
1549
|
+
cache_status: string | null;
|
|
1550
|
+
/** @description 0–1; null when no request had a verdict. */
|
|
1551
|
+
cache_hit_ratio: number | null;
|
|
1552
|
+
ttfb_ms: number | null;
|
|
1553
|
+
};
|
|
1554
|
+
/** @description cms monitors — the latest detection (no version is stored). */
|
|
1555
|
+
MonitorLatestCms: {
|
|
1556
|
+
/**
|
|
1557
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1558
|
+
* @enum {string}
|
|
1559
|
+
*/
|
|
1560
|
+
kind: "cms";
|
|
1561
|
+
/**
|
|
1562
|
+
* Format: date-time
|
|
1563
|
+
* @description When the check this block describes ran.
|
|
1564
|
+
*/
|
|
1565
|
+
checked_at: string | null;
|
|
1566
|
+
detected: boolean | null;
|
|
1567
|
+
/** @description e.g. "WordPress". */
|
|
1568
|
+
name: string | null;
|
|
1569
|
+
/** @description Which fingerprint matched. */
|
|
1570
|
+
source: string | null;
|
|
1571
|
+
};
|
|
1572
|
+
/** @description brotli monitors — the latest check. */
|
|
1573
|
+
MonitorLatestBrotli: {
|
|
1574
|
+
/**
|
|
1575
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1576
|
+
* @enum {string}
|
|
1577
|
+
*/
|
|
1578
|
+
kind: "brotli";
|
|
1579
|
+
/**
|
|
1580
|
+
* Format: date-time
|
|
1581
|
+
* @description When the check this block describes ran.
|
|
1582
|
+
*/
|
|
1583
|
+
checked_at: string | null;
|
|
1584
|
+
supported: boolean | null;
|
|
1585
|
+
};
|
|
1586
|
+
/** @description favicon monitors — the latest check. */
|
|
1587
|
+
MonitorLatestFavicon: {
|
|
1588
|
+
/**
|
|
1589
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1590
|
+
* @enum {string}
|
|
1591
|
+
*/
|
|
1592
|
+
kind: "favicon";
|
|
1593
|
+
/**
|
|
1594
|
+
* Format: date-time
|
|
1595
|
+
* @description When the check this block describes ran.
|
|
1596
|
+
*/
|
|
1597
|
+
checked_at: string | null;
|
|
1598
|
+
found: boolean | null;
|
|
1599
|
+
bytes: number | null;
|
|
1600
|
+
content_type_ok: boolean | null;
|
|
1601
|
+
};
|
|
1602
|
+
/** @description mcp monitors — the latest check. Counts are null when the handshake failed. */
|
|
1603
|
+
MonitorLatestMcp: {
|
|
1604
|
+
/**
|
|
1605
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1606
|
+
* @enum {string}
|
|
1607
|
+
*/
|
|
1608
|
+
kind: "mcp";
|
|
1609
|
+
/**
|
|
1610
|
+
* Format: date-time
|
|
1611
|
+
* @description When the check this block describes ran.
|
|
1612
|
+
*/
|
|
1613
|
+
checked_at: string | null;
|
|
1614
|
+
handshake_ok: boolean | null;
|
|
1615
|
+
server_name: string | null;
|
|
1616
|
+
server_version: string | null;
|
|
1617
|
+
protocol_version: string | null;
|
|
1618
|
+
tools_count: number | null;
|
|
1619
|
+
resources_count: number | null;
|
|
1620
|
+
prompts_count: number | null;
|
|
1621
|
+
/** @description Days until the certificate the latest check saw expires; null when it saw none (plain text, or failed before TLS). */
|
|
1622
|
+
cert_days_left: number | null;
|
|
1623
|
+
};
|
|
1624
|
+
/** @description browser (Core Web Vitals) monitors — the latest successful audit. Scores are 0–1, like the alert metrics; INP is null when the audit did not measure it. */
|
|
1625
|
+
MonitorLatestBrowser: {
|
|
1626
|
+
/**
|
|
1627
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1628
|
+
* @enum {string}
|
|
1629
|
+
*/
|
|
1630
|
+
kind: "browser";
|
|
1631
|
+
/**
|
|
1632
|
+
* Format: date-time
|
|
1633
|
+
* @description When the check this block describes ran.
|
|
1634
|
+
*/
|
|
1635
|
+
checked_at: string | null;
|
|
1636
|
+
performance_score: number | null;
|
|
1637
|
+
accessibility_score: number | null;
|
|
1638
|
+
seo_score: number | null;
|
|
1639
|
+
best_practices_score: number | null;
|
|
1640
|
+
lcp_ms: number | null;
|
|
1641
|
+
cls: number | null;
|
|
1642
|
+
inp_ms: number | null;
|
|
1643
|
+
fcp_ms: number | null;
|
|
1644
|
+
tbt_ms: number | null;
|
|
1645
|
+
/** @description "mobile" or "desktop". */
|
|
1646
|
+
preset: string | null;
|
|
1647
|
+
};
|
|
1648
|
+
/** @description playwright (browser check) monitors — the latest run that reached the site (infrastructure errors skipped). */
|
|
1649
|
+
MonitorLatestPlaywright: {
|
|
1650
|
+
/**
|
|
1651
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1652
|
+
* @enum {string}
|
|
1653
|
+
*/
|
|
1654
|
+
kind: "playwright";
|
|
1655
|
+
/**
|
|
1656
|
+
* Format: date-time
|
|
1657
|
+
* @description When the check this block describes ran.
|
|
1658
|
+
*/
|
|
1659
|
+
checked_at: string | null;
|
|
1660
|
+
/** @description passed | flaky | failed | timed_out | script_error (see the runs endpoint). */
|
|
1661
|
+
status: string | null;
|
|
1662
|
+
tests_total: number | null;
|
|
1663
|
+
tests_passed: number | null;
|
|
1664
|
+
tests_failed: number | null;
|
|
1665
|
+
steps_total: number | null;
|
|
1666
|
+
/** @description Title of the step the run failed at. */
|
|
1667
|
+
failed_step: string | null;
|
|
1668
|
+
console_errors: number | null;
|
|
1669
|
+
failed_requests: number | null;
|
|
1670
|
+
attempts: number | null;
|
|
1671
|
+
};
|
|
1672
|
+
/** @description integrity (page integrity) monitors — the latest check. */
|
|
1673
|
+
MonitorLatestIntegrity: {
|
|
1674
|
+
/**
|
|
1675
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1676
|
+
* @enum {string}
|
|
1677
|
+
*/
|
|
1678
|
+
kind: "integrity";
|
|
1679
|
+
/**
|
|
1680
|
+
* Format: date-time
|
|
1681
|
+
* @description When the check this block describes ran.
|
|
1682
|
+
*/
|
|
1683
|
+
checked_at: string | null;
|
|
1684
|
+
pages_checked: number | null;
|
|
1685
|
+
pages_changed: number | null;
|
|
1686
|
+
text_change_pct_max: number | null;
|
|
1687
|
+
/** @description New script/iframe/form/link origins, keyword hits, redirect, header and script changes — summed. */
|
|
1688
|
+
security_findings: number | null;
|
|
1689
|
+
/** @description Security headers removed or weakened. */
|
|
1690
|
+
headers_weakened: number | null;
|
|
1691
|
+
};
|
|
1692
|
+
/** @description imap monitors — the latest check. */
|
|
1693
|
+
MonitorLatestImap: {
|
|
1694
|
+
/**
|
|
1695
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1696
|
+
* @enum {string}
|
|
1697
|
+
*/
|
|
1698
|
+
kind: "imap";
|
|
1699
|
+
/**
|
|
1700
|
+
* Format: date-time
|
|
1701
|
+
* @description When the check this block describes ran.
|
|
1702
|
+
*/
|
|
1703
|
+
checked_at: string | null;
|
|
1704
|
+
/** @description null = connection-only check (no username configured). */
|
|
1705
|
+
login_ok: boolean | null;
|
|
1706
|
+
/** @description e.g. "TLS 1.3"; null without TLS. */
|
|
1707
|
+
tls_version: string | null;
|
|
1708
|
+
/** @description Days until the certificate the latest check saw expires; null when it saw none (plain text, or failed before TLS). */
|
|
1709
|
+
cert_days_left: number | null;
|
|
1710
|
+
cert_valid: boolean | null;
|
|
1711
|
+
plaintext_login_allowed: boolean | null;
|
|
1712
|
+
/** @description Mailbox message count; null when not measured. */
|
|
1713
|
+
messages: number | null;
|
|
1714
|
+
};
|
|
1715
|
+
/** @description pop3 monitors — the latest check. */
|
|
1716
|
+
MonitorLatestPop3: {
|
|
1717
|
+
/**
|
|
1718
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1719
|
+
* @enum {string}
|
|
1720
|
+
*/
|
|
1721
|
+
kind: "pop3";
|
|
1722
|
+
/**
|
|
1723
|
+
* Format: date-time
|
|
1724
|
+
* @description When the check this block describes ran.
|
|
1725
|
+
*/
|
|
1726
|
+
checked_at: string | null;
|
|
1727
|
+
/** @description null = connection-only check (no username configured). */
|
|
1728
|
+
login_ok: boolean | null;
|
|
1729
|
+
/** @description e.g. "TLS 1.3"; null without TLS. */
|
|
1730
|
+
tls_version: string | null;
|
|
1731
|
+
/** @description Days until the certificate the latest check saw expires; null when it saw none (plain text, or failed before TLS). */
|
|
1732
|
+
cert_days_left: number | null;
|
|
1733
|
+
cert_valid: boolean | null;
|
|
1734
|
+
plaintext_login_allowed: boolean | null;
|
|
1735
|
+
/** @description Mailbox message count; null when not measured. */
|
|
1736
|
+
messages: number | null;
|
|
1737
|
+
};
|
|
1738
|
+
/** @description ftp monitors — the latest check. */
|
|
1739
|
+
MonitorLatestFtp: {
|
|
1740
|
+
/**
|
|
1741
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1742
|
+
* @enum {string}
|
|
1743
|
+
*/
|
|
1744
|
+
kind: "ftp";
|
|
1745
|
+
/**
|
|
1746
|
+
* Format: date-time
|
|
1747
|
+
* @description When the check this block describes ran.
|
|
1748
|
+
*/
|
|
1749
|
+
checked_at: string | null;
|
|
1750
|
+
connected: boolean | null;
|
|
1751
|
+
login_ok: boolean | null;
|
|
1752
|
+
/** @description FTPS (explicit or implicit TLS). */
|
|
1753
|
+
secure: boolean | null;
|
|
1754
|
+
};
|
|
1755
|
+
/** @description sftp monitors — the latest check. */
|
|
1756
|
+
MonitorLatestSftp: {
|
|
1757
|
+
/**
|
|
1758
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1759
|
+
* @enum {string}
|
|
1760
|
+
*/
|
|
1761
|
+
kind: "sftp";
|
|
1762
|
+
/**
|
|
1763
|
+
* Format: date-time
|
|
1764
|
+
* @description When the check this block describes ran.
|
|
1765
|
+
*/
|
|
1766
|
+
checked_at: string | null;
|
|
1767
|
+
connected: boolean | null;
|
|
1768
|
+
login_ok: boolean | null;
|
|
1769
|
+
};
|
|
1770
|
+
/** @description email_roundtrip monitors — the latest run. Everything read off the received message is null when it was not delivered. */
|
|
1771
|
+
MonitorLatestEmailRoundtrip: {
|
|
1772
|
+
/**
|
|
1773
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1774
|
+
* @enum {string}
|
|
1775
|
+
*/
|
|
1776
|
+
kind: "email_roundtrip";
|
|
1777
|
+
/**
|
|
1778
|
+
* Format: date-time
|
|
1779
|
+
* @description When the check this block describes ran.
|
|
1780
|
+
*/
|
|
1781
|
+
checked_at: string | null;
|
|
1782
|
+
delivered: boolean | null;
|
|
1783
|
+
delivery_ms: number | null;
|
|
1784
|
+
in_spam: boolean | null;
|
|
1785
|
+
spf_pass: boolean | null;
|
|
1786
|
+
dkim_pass: boolean | null;
|
|
1787
|
+
dmarc_pass: boolean | null;
|
|
1788
|
+
spam_score: number | null;
|
|
1789
|
+
};
|
|
1790
|
+
/** @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. */
|
|
1791
|
+
MonitorLatest:
|
|
1792
|
+
| components["schemas"]["MonitorLatestSsl"]
|
|
1793
|
+
| components["schemas"]["MonitorLatestRdap"]
|
|
1794
|
+
| components["schemas"]["MonitorLatestHeartbeat"]
|
|
1795
|
+
| components["schemas"]["MonitorLatestHttp"]
|
|
1796
|
+
| components["schemas"]["MonitorLatestApi"]
|
|
1797
|
+
| components["schemas"]["MonitorLatestTcp"]
|
|
1798
|
+
| components["schemas"]["MonitorLatestUdp"]
|
|
1799
|
+
| components["schemas"]["MonitorLatestIcmp"]
|
|
1800
|
+
| components["schemas"]["MonitorLatestDns"]
|
|
1801
|
+
| components["schemas"]["MonitorLatestSmtp"]
|
|
1802
|
+
| components["schemas"]["MonitorLatestSitemap"]
|
|
1803
|
+
| components["schemas"]["MonitorLatestMtr"]
|
|
1804
|
+
| components["schemas"]["MonitorLatestNtp"]
|
|
1805
|
+
| components["schemas"]["MonitorLatestWebsocket"]
|
|
1806
|
+
| components["schemas"]["MonitorLatestBlacklist"]
|
|
1807
|
+
| components["schemas"]["MonitorLatestBreach"]
|
|
1808
|
+
| components["schemas"]["MonitorLatestEmailPolicy"]
|
|
1809
|
+
| components["schemas"]["MonitorLatestCdn"]
|
|
1810
|
+
| components["schemas"]["MonitorLatestCms"]
|
|
1811
|
+
| components["schemas"]["MonitorLatestBrotli"]
|
|
1812
|
+
| components["schemas"]["MonitorLatestFavicon"]
|
|
1813
|
+
| components["schemas"]["MonitorLatestMcp"]
|
|
1814
|
+
| components["schemas"]["MonitorLatestBrowser"]
|
|
1815
|
+
| components["schemas"]["MonitorLatestPlaywright"]
|
|
1816
|
+
| components["schemas"]["MonitorLatestIntegrity"]
|
|
1817
|
+
| components["schemas"]["MonitorLatestImap"]
|
|
1818
|
+
| components["schemas"]["MonitorLatestPop3"]
|
|
1819
|
+
| components["schemas"]["MonitorLatestFtp"]
|
|
1820
|
+
| components["schemas"]["MonitorLatestSftp"]
|
|
1821
|
+
| components["schemas"]["MonitorLatestEmailRoundtrip"];
|
|
1168
1822
|
PlaywrightTestRunRequest: {
|
|
1169
1823
|
/** @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`. */
|
|
1170
1824
|
script: string;
|
|
@@ -1814,35 +2468,8 @@ export interface components {
|
|
|
1814
2468
|
region: string;
|
|
1815
2469
|
country_code: string;
|
|
1816
2470
|
}[];
|
|
1817
|
-
/** @description Type-aware summary of the monitor page's top
|
|
1818
|
-
latest?:
|
|
1819
|
-
| {
|
|
1820
|
-
days_until_expiry?: number | null;
|
|
1821
|
-
/** Format: date-time */
|
|
1822
|
-
not_after?: string | null;
|
|
1823
|
-
issuer?: string | null;
|
|
1824
|
-
protocol?: string | null;
|
|
1825
|
-
valid?: boolean | null;
|
|
1826
|
-
}
|
|
1827
|
-
| {
|
|
1828
|
-
/** Format: date-time */
|
|
1829
|
-
expires_at?: string | null;
|
|
1830
|
-
days_until_expiry?: number | null;
|
|
1831
|
-
registrar?: string | null;
|
|
1832
|
-
nameservers?: string[];
|
|
1833
|
-
}
|
|
1834
|
-
| {
|
|
1835
|
-
/** Format: date-time */
|
|
1836
|
-
last_ping_at?: string | null;
|
|
1837
|
-
/**
|
|
1838
|
-
* Format: date-time
|
|
1839
|
-
* @description Period schedules only; null for cron.
|
|
1840
|
-
*/
|
|
1841
|
-
next_expected_at?: string | null;
|
|
1842
|
-
missed?: boolean;
|
|
1843
|
-
last_exit_code?: number | null;
|
|
1844
|
-
}
|
|
1845
|
-
| null;
|
|
2471
|
+
/** @description Type-aware summary of the monitor page's top cards — `kind` is the monitor's type (discriminator). null when the monitor has no check yet, or the analytics store could not be reached (best effort). */
|
|
2472
|
+
latest?: components["schemas"]["MonitorLatest"] | null;
|
|
1846
2473
|
available_metrics: components["schemas"]["CatalogAlertMetric"][];
|
|
1847
2474
|
};
|
|
1848
2475
|
MonitorCreate: {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "watchfor",
|
|
3
|
-
"version": "0.17.
|
|
3
|
+
"version": "0.17.1",
|
|
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",
|