updown.io 3.4.5 → 3.4.6

package/package.json

@@ -1,14 +1,14 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
   "dependencies": {
-    "@ffflorian/api-client": "2.2.0"
+    "@ffflorian/api-client": "2.5.0"
   },
   "description": "An updown.io API client",
   "devDependencies": {
     "@types/node": "~24",
-    "rimraf": "6.1.2",
-    "typedoc": "0.28.15",
-    "typescript": "5.9.3"
+    "rimraf": "6.1.3",
+    "typedoc": "0.28.18",
+    "typescript": "6.0.2"
   },
   "engines": {
     "node": ">= 21"
@@ -35,6 +35,5 @@
     "dist": "yarn clean && yarn build:ts",
     "test": "exit 0"
   },
-  "version": "3.4.5",
-  "gitHead": "8d7471cbe490305b3e441c27acbc81e36a4bd9df"
+  "version": "3.4.6"
 }

package/dist/Endpoints.d.ts

@@ -1,19 +0,0 @@
-export declare const Endpoint: {
-    CHECKS: string;
-    DOWNTIMES: string;
-    METRICS: string;
-    NODES: string;
-    IPV4: string;
-    IPV6: string;
-    Checks: {
-        check(token: string): string;
-        downtimes(token: string): string;
-        metrics(token: string): string;
-    };
-    Nodes: {
-        ipv4(): string;
-        ipv6(): string;
-    };
-    checks(token?: string): string;
-    nodes(): string;
-};

package/dist/Endpoints.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Endpoint = void 0;
-const encode = encodeURIComponent;
-exports.Endpoint = {
-    CHECKS: 'checks',
-    DOWNTIMES: 'downtimes',
-    METRICS: 'metrics',
-    NODES: 'nodes',
-    IPV4: 'ipv4',
-    IPV6: 'ipv6',
-    Checks: {
-        check(token) {
-            return `/${exports.Endpoint.CHECKS}/${encode(token)}/`;
-        },
-        downtimes(token) {
-            return `/${exports.Endpoint.CHECKS}/${encode(token)}/${exports.Endpoint.DOWNTIMES}/`;
-        },
-        metrics(token) {
-            return `/${exports.Endpoint.CHECKS}/${encode(token)}/${exports.Endpoint.METRICS}/`;
-        },
-    },
-    Nodes: {
-        ipv4() {
-            return `/${exports.Endpoint.NODES}/${exports.Endpoint.IPV4}/`;
-        },
-        ipv6() {
-            return `/${exports.Endpoint.NODES}/${exports.Endpoint.IPV6}/`;
-        },
-    },
-    checks(token) {
-        return `/${exports.Endpoint.CHECKS}/${token ? `${encode(token)}/` : ''}`;
-    },
-    nodes() {
-        return `/${exports.Endpoint.NODES}/`;
-    },
-};

package/dist/UpdownIO.d.ts

@@ -1,12 +0,0 @@
-import type { API, ClientOptions } from './interfaces';
-export declare class UpdownIO {
-    api: API;
-    private readonly apiClient;
-    constructor(apiKey?: string);
-    constructor(options?: ClientOptions);
-    /**
-     * Set a new API URL.
-     * @param newURL The new API url
-     */
-    setApiUrl(newURL: string): void;
-}

package/dist/UpdownIO.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdownIO = void 0;
-const api_client_1 = require("@ffflorian/api-client");
-const api_1 = require("./api");
-class UpdownIO {
-    constructor(options) {
-        if (typeof options === 'string') {
-            options = { apiKey: options };
-        }
-        this.apiClient = new api_client_1.APIClient('https://updown.io/api/', {
-            headers: Object.assign({}, ((options === null || options === void 0 ? void 0 : options.apiKey) && { 'X-API-KEY': options.apiKey })),
-        });
-        this.api = {
-            checks: new api_1.ChecksAPI(this.apiClient),
-            nodes: new api_1.NodesAPI(this.apiClient),
-        };
-    }
-    /**
-     * Set a new API URL.
-     * @param newURL The new API url
-     */
-    setApiUrl(newURL) {
-        this.api.checks.setApiUrl(newURL);
-        this.api.nodes.setApiUrl(newURL);
-    }
-}
-exports.UpdownIO = UpdownIO;

package/dist/api/ChecksAPI.d.ts

@@ -1,55 +0,0 @@
-import type { APIClient } from '@ffflorian/api-client';
-import type { Check, CheckOptions, Deleted, Downtime, Metrics, MetricsOptions } from '../interfaces';
-export declare class ChecksAPI {
-    private readonly apiClient;
-    constructor(apiClient: APIClient);
-    /**
-     * Add a new check.
-     * @param url The URL you want to monitor.
-     * @param options Further check adding options
-     */
-    addCheck(url: string, options?: CheckOptions): Promise<Check>;
-    /**
-     * Delete a check.
-     * @param token The check unique token
-     */
-    deleteCheck(token: string): Promise<Deleted>;
-    /**
-     * Show a single check.
-     * @param token The check unique token
-     * @param metrics Include performance metrics (last hour only)
-     */
-    getCheck(token: string, metrics?: boolean): Promise<Check>;
-    /** List all your checks. */
-    getChecks(): Promise<Check[]>;
-    /**
-     * Get all the downtimes of a check.
-     *
-     * @param token The check unique token
-     * @param page The page to fetch (100 per page)
-     */
-    getDowntimes(token: string, page?: number): Promise<Downtime[]>;
-    /**
-     * Get detailed metrics about the check.
-     *
-     * Statistic are aggregated per hour which means you can't get more
-     * precise results than this. For example all requests performed
-     * between 5:00 and 5:59 will be reported at 5:00 in this API.
-     * The time range needs to be at least one hour to get data.
-     *
-     * @param token The check unique token
-     * @param page The page to fetch (100 per page)
-     */
-    getMetrics(token: string, options?: MetricsOptions): Promise<Metrics>;
-    /**
-     * Set a new API URL.
-     * @param newURL The new API url
-     */
-    setApiUrl(newURL: string): void;
-    /**
-     * Update a check.
-     * @param token The check unique token
-     * @param options Further check updating options
-     */
-    updateCheck(token: string, options?: CheckOptions): Promise<Check>;
-}

package/dist/api/ChecksAPI.js

@@ -1,113 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChecksAPI = void 0;
-const Endpoints_1 = require("../Endpoints");
-class ChecksAPI {
-    constructor(apiClient) {
-        this.apiClient = apiClient;
-    }
-    /**
-     * Add a new check.
-     * @param url The URL you want to monitor.
-     * @param options Further check adding options
-     */
-    addCheck(url, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.checks();
-            const params = Object.assign({ url }, options);
-            const { data } = yield this.apiClient.post(endpoint, params);
-            return data;
-        });
-    }
-    /**
-     * Delete a check.
-     * @param token The check unique token
-     */
-    deleteCheck(token) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.checks(token);
-            const { data } = yield this.apiClient.delete(endpoint);
-            return data;
-        });
-    }
-    /**
-     * Show a single check.
-     * @param token The check unique token
-     * @param metrics Include performance metrics (last hour only)
-     */
-    getCheck(token, metrics) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.Checks.check(token);
-            const { data } = yield this.apiClient.get(endpoint, { data: { metrics } });
-            return data;
-        });
-    }
-    /** List all your checks. */
-    getChecks() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.checks();
-            const { data } = yield this.apiClient.get(endpoint);
-            return data;
-        });
-    }
-    /**
-     * Get all the downtimes of a check.
-     *
-     * @param token The check unique token
-     * @param page The page to fetch (100 per page)
-     */
-    getDowntimes(token, page) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.Checks.downtimes(token);
-            const { data } = yield this.apiClient.get(endpoint, { params: { page } });
-            return data;
-        });
-    }
-    /**
-     * Get detailed metrics about the check.
-     *
-     * Statistic are aggregated per hour which means you can't get more
-     * precise results than this. For example all requests performed
-     * between 5:00 and 5:59 will be reported at 5:00 in this API.
-     * The time range needs to be at least one hour to get data.
-     *
-     * @param token The check unique token
-     * @param page The page to fetch (100 per page)
-     */
-    getMetrics(token, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.Checks.downtimes(token);
-            const { data } = yield this.apiClient.get(endpoint, { params: options });
-            return data;
-        });
-    }
-    /**
-     * Set a new API URL.
-     * @param newURL The new API url
-     */
-    setApiUrl(newURL) {
-        this.apiClient.setBaseURL(newURL);
-    }
-    /**
-     * Update a check.
-     * @param token The check unique token
-     * @param options Further check updating options
-     */
-    updateCheck(token, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.checks(token);
-            const { data } = yield this.apiClient.put(endpoint, options);
-            return data;
-        });
-    }
-}
-exports.ChecksAPI = ChecksAPI;

package/dist/api/NodesAPI.d.ts

@@ -1,17 +0,0 @@
-import type { APIClient } from '@ffflorian/api-client';
-import type { Nodes } from '../interfaces';
-export declare class NodesAPI {
-    private readonly apiClient;
-    constructor(apiClient: APIClient);
-    /** List all updown.io monitoring nodes IPv4 addresses. */
-    getIpv4Nodes(): Promise<string[]>;
-    /** List all updown.io monitoring nodes IPv6 addresses. */
-    getIpv6Nodes(): Promise<string[]>;
-    /** List all updown.io monitoring nodes. */
-    getNodes(): Promise<Nodes>;
-    /**
-     * Set a new API URL.
-     * @param newURL The new API url
-     */
-    setApiUrl(newURL: string): void;
-}

package/dist/api/NodesAPI.js

@@ -1,50 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NodesAPI = void 0;
-const Endpoints_1 = require("../Endpoints");
-class NodesAPI {
-    constructor(apiClient) {
-        this.apiClient = apiClient;
-    }
-    /** List all updown.io monitoring nodes IPv4 addresses. */
-    getIpv4Nodes() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.Nodes.ipv4();
-            const { data } = yield this.apiClient.get(endpoint);
-            return data;
-        });
-    }
-    /** List all updown.io monitoring nodes IPv6 addresses. */
-    getIpv6Nodes() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.Nodes.ipv6();
-            const { data } = yield this.apiClient.get(endpoint);
-            return data;
-        });
-    }
-    /** List all updown.io monitoring nodes. */
-    getNodes() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.nodes();
-            const { data } = yield this.apiClient.get(endpoint);
-            return data;
-        });
-    }
-    /**
-     * Set a new API URL.
-     * @param newURL The new API url
-     */
-    setApiUrl(newURL) {
-        this.apiClient.setBaseURL(newURL);
-    }
-}
-exports.NodesAPI = NodesAPI;

package/dist/api/index.d.ts

@@ -1,2 +0,0 @@
-export * from './ChecksAPI';
-export * from './NodesAPI';

package/dist/api/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./ChecksAPI"), exports);
-__exportStar(require("./NodesAPI"), exports);

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-export * from './UpdownIO';
-export * from './interfaces/';

package/dist/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./UpdownIO"), exports);
-__exportStar(require("./interfaces/"), exports);

package/dist/interfaces/API.d.ts

@@ -1,5 +0,0 @@
-import { ChecksAPI, NodesAPI } from '../api/';
-export interface API {
-    checks: ChecksAPI;
-    nodes: NodesAPI;
-}

package/dist/interfaces/API.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Check.d.ts

@@ -1,27 +0,0 @@
-import type { CustomHeaders } from './Options';
-export interface Check {
-    alias: string;
-    apdex_t: number;
-    custom_headers: CustomHeaders;
-    disabled_locations: string[];
-    down: boolean;
-    down_since: string | null;
-    enabled: boolean;
-    error: string | null;
-    favicon_url: string | null;
-    last_check_at: string;
-    last_status: number;
-    mute_until: string | null;
-    next_check_at: string;
-    period: number;
-    published: boolean;
-    ssl: {
-        error: string | null;
-        tested_at: string;
-        valid: boolean;
-    };
-    string_match: number;
-    token: string;
-    uptime: number;
-    url: string;
-}

package/dist/interfaces/Check.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Deleted.d.ts

@@ -1,3 +0,0 @@
-export interface Deleted {
-    deleted: boolean;
-}

package/dist/interfaces/Deleted.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Downtime.d.ts

@@ -1,6 +0,0 @@
-export interface Downtime {
-    duration: number;
-    ended_at: string;
-    error: string;
-    started_at: string;
-}

package/dist/interfaces/Downtime.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Metrics.d.ts

@@ -1,25 +0,0 @@
-export interface Metrics {
-    apdex: number;
-    requests: {
-        by_response_time: {
-            under1000: number;
-            under125: number;
-            under2000: number;
-            under250: number;
-            under4000: number;
-            under500: number;
-        };
-        failures: number;
-        samples: number;
-        satisfied: number;
-        tolerated: number;
-    };
-    timings: {
-        connection: number;
-        handshake: number;
-        namelookup: number;
-        redirect: number;
-        response: number;
-        total: number;
-    };
-}

package/dist/interfaces/Metrics.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Nodes.d.ts

@@ -1,11 +0,0 @@
-export interface Nodes {
-    [name: string]: {
-        city: string;
-        country: string;
-        country_code: string;
-        ip: string;
-        ip6: string;
-        lat: number;
-        lng: number;
-    };
-}

package/dist/interfaces/Nodes.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Options.d.ts

@@ -1,56 +0,0 @@
-export interface ClientOptions {
-    apiKey: string;
-    apiUrl?: string;
-}
-export interface CustomHeaders {
-    [key: string]: string | number | boolean;
-}
-export type HttpMethod = 'delete' | 'get' | 'post' | 'put';
-type MetricsGroup = 'time' | 'host';
-export interface RequestOptions {
-    alias?: string;
-    apdex_t?: number;
-    'api-key'?: string;
-    custom_headers?: CustomHeaders;
-    disabled_locations?: string[];
-    enabled?: boolean;
-    from?: string;
-    group?: MetricsGroup;
-    metrics?: boolean;
-    mute_until?: string;
-    page?: number;
-    period?: number;
-    published?: boolean;
-    string_match?: string;
-    to?: string;
-    url?: string;
-}
-export interface MetricsOptions {
-    /** Start time, default to 1 month ago */
-    from?: string;
-    /** Group data by 'time' (hour) or 'host' (location) */
-    group: MetricsGroup;
-    /** End time, default to now */
-    to?: string;
-}
-export interface CheckOptions {
-    /** Human readable name */
-    alias?: string;
-    /** APDEX threshold in seconds (0.125, 0.25, 0.5, 1.0 or 2.0) */
-    apdex_t?: number;
-    /** The HTTP headers you want in updown requests. Ex: custom_headers[X-Api-Key]=xxxxxxxxx */
-    customHeaders?: CustomHeaders;
-    /** Disabled monitoring locations. It's an array of abbreviated location names. Can be any of these: ["lan", "mia", "bhs", "gra", "fra", "sin", "tok", "syd"]. Ex: disabled_locations[]=lan&disabled_locations[]=syd */
-    disabledLocations?: string[];
-    /** Is the check enabled (true or false) */
-    enabled?: boolean;
-    /** Mute notifications until given time, accepts a time, 'recovery' or 'forever' */
-    mute_until?: string;
-    /** Interval in seconds (15, 30, 60, 120, 300, 600, 1800 or 3600) */
-    period?: number;
-    /** Shall the status page be public (true or false) */
-    published?: boolean;
-    /** Search for this string in the page */
-    string_match?: string;
-}
-export {};

package/dist/interfaces/Options.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/index.d.ts

@@ -1,7 +0,0 @@
-export * from './API';
-export * from './Check';
-export * from './Deleted';
-export * from './Downtime';
-export * from './Metrics';
-export * from './Nodes';
-export * from './Options';

package/dist/interfaces/index.js

@@ -1,23 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./API"), exports);
-__exportStar(require("./Check"), exports);
-__exportStar(require("./Deleted"), exports);
-__exportStar(require("./Downtime"), exports);
-__exportStar(require("./Metrics"), exports);
-__exportStar(require("./Nodes"), exports);
-__exportStar(require("./Options"), exports);