updown.io 3.4.5 → 3.4.7

package/dist/Endpoints.d.ts

@@ -1,19 +1,19 @@
 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;
     };
+    checks(token?: string): string;
+    DOWNTIMES: string;
+    IPV4: string;
+    IPV6: string;
+    METRICS: string;
+    NODES: string;
     Nodes: {
         ipv4(): string;
         ipv6(): string;
     };
-    checks(token?: string): string;
     nodes(): string;
 };

package/dist/Endpoints.js

@@ -4,11 +4,6 @@ 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)}/`;
@@ -20,6 +15,14 @@ exports.Endpoint = {
             return `/${exports.Endpoint.CHECKS}/${encode(token)}/${exports.Endpoint.METRICS}/`;
         },
     },
+    checks(token) {
+        return `/${exports.Endpoint.CHECKS}/${token ? `${encode(token)}/` : ''}`;
+    },
+    DOWNTIMES: 'downtimes',
+    IPV4: 'ipv4',
+    IPV6: 'ipv6',
+    METRICS: 'metrics',
+    NODES: 'nodes',
     Nodes: {
         ipv4() {
             return `/${exports.Endpoint.NODES}/${exports.Endpoint.IPV4}/`;
@@ -28,9 +31,6 @@ exports.Endpoint = {
             return `/${exports.Endpoint.NODES}/${exports.Endpoint.IPV6}/`;
         },
     },
-    checks(token) {
-        return `/${exports.Endpoint.CHECKS}/${token ? `${encode(token)}/` : ''}`;
-    },
     nodes() {
         return `/${exports.Endpoint.NODES}/`;
     },

package/dist/api/ChecksAPI.d.ts

@@ -38,7 +38,7 @@ export declare class ChecksAPI {
      * 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)
+     * @param options Metrics options
      */
     getMetrics(token: string, options?: MetricsOptions): Promise<Metrics>;
     /**

package/dist/api/ChecksAPI.js

@@ -81,7 +81,7 @@ class ChecksAPI {
      * 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)
+     * @param options Metrics options
      */
     getMetrics(token, options) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/index.d.ts

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

package/dist/index.js

@@ -14,5 +14,6 @@ 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("./api/"), exports);
 __exportStar(require("./interfaces/"), exports);
+__exportStar(require("./UpdownIO"), exports);

package/dist/interfaces/Check.d.ts

@@ -5,18 +5,18 @@ export interface Check {
     custom_headers: CustomHeaders;
     disabled_locations: string[];
     down: boolean;
-    down_since: string | null;
+    down_since: null | string;
     enabled: boolean;
-    error: string | null;
-    favicon_url: string | null;
+    error: null | string;
+    favicon_url: null | string;
     last_check_at: string;
     last_status: number;
-    mute_until: string | null;
+    mute_until: null | string;
     next_check_at: string;
     period: number;
     published: boolean;
     ssl: {
-        error: string | null;
+        error: null | string;
         tested_at: string;
         valid: boolean;
     };

package/dist/interfaces/Options.d.ts

@@ -1,12 +1,40 @@
+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 interface ClientOptions {
     apiKey: string;
     apiUrl?: string;
 }
 export interface CustomHeaders {
-    [key: string]: string | number | boolean;
+    [key: string]: boolean | number | string;
 }
 export type HttpMethod = 'delete' | 'get' | 'post' | 'put';
-type MetricsGroup = 'time' | 'host';
+export type MetricsGroup = 'host' | 'time';
+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 RequestOptions {
     alias?: string;
     apdex_t?: number;
@@ -25,32 +53,3 @@ export interface RequestOptions {
     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/package.json

@@ -1,14 +1,14 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
   "dependencies": {
-    "@ffflorian/api-client": "2.2.0"
+    "@ffflorian/api-client": "2.5.1"
   },
   "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"
@@ -29,12 +29,12 @@
   "readme": "https://github.com/ffflorian/api-clients#readme",
   "repository": "https://github.com/ffflorian/api-clients.git",
   "scripts": {
+    "build": "yarn build:ts",
     "build:ts": "tsc -p tsconfig.build.json",
     "build:docs": "typedoc --tsconfig tsconfig.build.json --options ../../typedoc.json --out ../../docs/packages/updown.io src/index.ts",
     "clean": "rimraf dist",
-    "dist": "yarn clean && yarn build:ts",
+    "dist": "yarn clean && yarn build",
     "test": "exit 0"
   },
-  "version": "3.4.5",
-  "gitHead": "8d7471cbe490305b3e441c27acbc81e36a4bd9df"
+  "version": "3.4.7"
 }