@gibme/mikrotik 2.0.5 → 3.0.0

package/dist/index.d.ts

@@ -1,24 +1,9 @@
-import SSH, { AbortController, AbortSignal } from '@gibme/ssh';
-import { BandwidthTest, Response } from './types';
+import SSH from '@gibme/ssh';
 import Cache from '@gibme/cache/memory';
+import { AbortController, AbortSignal } from 'abort-controller';
 export { AbortController, AbortSignal };
 export type { ConnectConfig } from '@gibme/ssh';
-export type Direction = BandwidthTest.Direction;
-export type Protocol = BandwidthTest.Protocol;
-export type Status = BandwidthTest.Status;
-export type Update = BandwidthTest.Update;
-export type Options = BandwidthTest.Options;
-export type Address = Response.Address;
-export type Interface = Response.Interface;
-export type Tunnel = Response.Tunnel;
-export type Route = Response.Route;
-export type RouteCount = Response.RouteCount;
-export type Ping = Response.Ping;
-export type Traceroute = Response.Traceroute;
-export type RouterBoard = Response.Routerboard;
-export type Resource = Response.Resource;
-export type Health = Response.Health;
-export default class Mikrotik extends SSH {
+export declare class Mikrotik extends SSH {
     protected static cache: Cache;
     /**
      * Retrieves the routes in the routing table
@@ -27,19 +12,19 @@ export default class Mikrotik extends SSH {
      * @param vrf
      * @param active_only
      */
-    get_ip_routes(min_distance?: number, vrf?: string, active_only?: boolean): Promise<Route[]>;
+    get_ip_routes(min_distance?: number, vrf?: string, active_only?: boolean): Promise<Mikrotik.Response.Route[]>;
     /**
      * Retrieves the IP addresses active on the system
      *
      * @param active_only
      */
-    get_ip_addresses(active_only?: boolean): Promise<Address[]>;
+    get_ip_addresses(active_only?: boolean): Promise<Mikrotik.Response.Address[]>;
     /**
      * Retrieves the interfaces active on the system
      *
      * @param active_only
      */
-    get_interfaces(active_only?: boolean): Promise<Interface[]>;
+    get_interfaces(active_only?: boolean): Promise<Mikrotik.Response.Interface[]>;
     /**
      * For all device IP addresses, counts the routes that exit (either directly or tunneled)
      * the device using each IP address
@@ -47,7 +32,7 @@ export default class Mikrotik extends SSH {
      * @param min_distance
      * @param vrf
      */
-    get_route_counts(min_distance?: number, vrf?: string): Promise<Record<string, RouteCount>>;
+    get_route_counts(min_distance?: number, vrf?: string): Promise<Record<string, Mikrotik.Response.Route.Count>>;
     /**
      * Executes a bandwidth test
      *
@@ -60,25 +45,25 @@ export default class Mikrotik extends SSH {
      * @param password
      * @param options
      */
-    bandwidth_test(target: string, username: string, password: string, options?: Partial<Options>): Promise<Update>;
+    bandwidth_test(target: string, username: string, password: string, options?: Partial<Mikrotik.BandwidthTest.Options>): Promise<Mikrotik.BandwidthTest.Update>;
     /**
      * Pings the target IP address from the source IP address (if supplied)
      *
      * @param target
      * @param source
      */
-    ping(target: string, source?: string): Promise<Ping>;
+    ping(target: string, source?: string): Promise<Mikrotik.Response.Ping>;
     /**
      * Performs a traceroute to the target IP address from the source IP address (if supplied)
      *
      * @param target
      * @param source
      */
-    traceroute(target: string, source?: string): Promise<Traceroute[]>;
+    traceroute(target: string, source?: string): Promise<Mikrotik.Response.Traceroute[]>;
     /**
      * Fetches routerboard information from the device
      */
-    routerboard(): Promise<Response.Routerboard>;
+    routerboard(): Promise<Mikrotik.Response.Routerboard>;
     /**
      * Fetches the identity of the device
      */
@@ -86,7 +71,7 @@ export default class Mikrotik extends SSH {
     /**
      * Fetches the resource information of the device
      */
-    resource(): Promise<Response.Resource>;
+    resource(): Promise<Mikrotik.Response.Resource>;
     /**
      * Fetches the current RouterOS version
      */
@@ -102,7 +87,7 @@ export default class Mikrotik extends SSH {
     /**
      * Fetches the current health information
      */
-    health(): Promise<Response.Health>;
+    health(): Promise<Mikrotik.Response.V6.Health | Mikrotik.Response.V7.Health>;
     /**
      * Executes a command with expected terse response and parses it accordingly
      *
@@ -118,3 +103,266 @@ export default class Mikrotik extends SSH {
      */
     kvs<Type extends object = any>(command: string): Promise<Type>;
 }
+export declare namespace Mikrotik {
+    namespace BandwidthTest {
+        type Direction = 'both' | 'transmit' | 'receive';
+        type Protocol = 'udp' | 'tcp';
+        type Status = 'running' | 'connecting' | 'done testing' | 'authentication_failed' | 'queued';
+        /**
+         * Class that helps with processing a "frame" of the Bandwidth Test response
+         */
+        class Frame {
+            readonly buffer: Buffer;
+            private parsed?;
+            constructor(buffer: Buffer);
+            parse(): Record<string, string>;
+        }
+        interface DirectionStats {
+            current: number;
+            shortAverage: number;
+            totalAverage: number;
+            size: number;
+        }
+        interface Update {
+            status: Status;
+            duration: number;
+            transmit?: DirectionStats;
+            receive?: DirectionStats;
+            lostPackets?: number;
+            randomData: boolean;
+            direction: Direction;
+            connectionCount: number;
+            localCPULoad: number;
+            remoteCPULoad: number;
+        }
+        interface Options {
+            duration: number;
+            direction: Direction;
+            protocol: Protocol;
+            random_data: boolean;
+            callback: (frame: Update) => void;
+            timeout: number;
+            signal: AbortSignal;
+            /**
+             * In Megabits
+             */
+            local_tx_speed: number;
+            /**
+             * In Megabits
+             */
+            remote_tx_speed: number;
+        }
+    }
+    type YesNo = 'yes' | 'no';
+    type Comment = {
+        comment?: string;
+    };
+    namespace Response {
+        namespace Command {
+            type Route = Comment & {
+                'dst-address': string;
+                gateway: string;
+                distance: string;
+                scope: string;
+                target_scope: string;
+                'routing-table'?: string;
+                'routing-mark'?: string;
+                'bgp-as-path'?: string;
+                'bgp-origin'?: string;
+                'bgp-local-pref'?: string;
+                'received-from'?: string;
+                'check-gateway'?: string;
+                'suppress-hw-offload'?: string;
+                'blackhole'?: string;
+                'immediate-gw'?: string;
+                reachable?: string;
+                'gateway-status'?: string;
+            };
+            type Address = Comment & {
+                address: string;
+                network: string;
+                interface: string;
+                'actual-interface': string;
+            };
+            type Interface = Comment & {
+                name: string;
+                type: string;
+                mtu: string;
+                'default-name'?: string;
+                'actual-mtu': string;
+                'mac-address'?: string;
+                'link-downs'?: string;
+                l2mtu?: string;
+            };
+            type Tunnel = Omit<Interface, 'type'> & Comment & {
+                'local-address': string;
+                'remote-address': string;
+                'clamp-tcp-mss': YesNo;
+                'dont-fragment': YesNo;
+                'allow-fast-path': YesNo;
+            };
+            type Routerboard = {
+                routerboard: YesNo;
+                'board-name': string;
+                model: string;
+                'serial-number': string;
+                'firmware-type': string;
+                'factory-firmware': string;
+                'current-firmware': string;
+                'upgrade-firmware': string;
+            };
+            type Identity = {
+                name: string;
+            };
+            type Resource = {
+                uptime: string;
+                version: string;
+                'build-time': string;
+                'factory-software': string;
+                'free-memory': string;
+                'total-memory': string;
+                cpu: string;
+                'cpu-count': string;
+                'cpu-frequency': string;
+                'cpu-load': string;
+                'free-hdd-space': string;
+                'total-hdd-space': string;
+                'architecture-name': string;
+                'board-name': string;
+                platform: string;
+                'write-sect-since-reboot'?: string;
+                'write-sect-total'?: string;
+                'bad-blocks'?: string;
+            };
+            namespace V6 {
+                type Health = {
+                    voltage: string;
+                    current: string;
+                    temperature: string;
+                    'power-consumption': string;
+                    'psu-voltage'?: string;
+                    'psu1-voltage'?: string;
+                    'psu2-voltage'?: string;
+                };
+            }
+        }
+        type includesAddress = {
+            includes(ipaddress: string): boolean;
+        };
+        type Address = includesAddress & Comment & {
+            ipaddress: string;
+            network: string;
+            cidr: number;
+            iface: string;
+        };
+        type Interface = Comment & {
+            name: string;
+            type: string;
+            local_address?: string;
+            remote_address?: string;
+        };
+        type Tunnel = Interface & {
+            parent: Address;
+        };
+        type Route = includesAddress & Comment & {
+            network: string;
+            cidr: number;
+            distance: number;
+            scope: number;
+            vrf: string;
+            preferred_source?: string;
+            gateway?: string;
+            iface?: string;
+            tunnel?: Tunnel;
+            target_scope?: number;
+        };
+        namespace Route {
+            type Count = {
+                interface: string;
+                count: number;
+                active: boolean;
+            };
+        }
+        type Ping = {
+            target: string;
+            latency: number;
+            source?: string;
+        };
+        type Traceroute = {
+            hop: number;
+            loss: number;
+            sent: number;
+            last: number;
+            average: number;
+            best: number;
+            worst: number;
+            timeout: boolean;
+            address?: string;
+            hostname?: string;
+        };
+        type Routerboard = {
+            routerboard: boolean;
+            board_name: string;
+            model: string;
+            serial_number: string;
+            firmware_type: string;
+            factory_firmware: string;
+            current_firmware: string;
+            upgrade_firmware: string;
+        };
+        type Resource = {
+            uptime: string;
+            version: string;
+            build_time: Date;
+            factory_sofware: string;
+            free_memory: string;
+            total_memory: string;
+            cpu: string;
+            cpu_count: number;
+            cpu_frequency: number;
+            cpu_load: number;
+            hdd_space: {
+                free: string;
+                total: string;
+            };
+            architecture_name: string;
+            board_name: string;
+            platform: string;
+            lts?: boolean;
+            stable?: boolean;
+            testing?: boolean;
+            development?: boolean;
+            nvram?: {
+                write_since_reboot: number;
+                write_total: number;
+                bad_blocks: number;
+            };
+        };
+        namespace V6 {
+            type Health = {
+                voltage: number;
+                current: number;
+                temperature: number;
+                power_consumption: number;
+                psu_voltage?: number;
+                psu1_voltage?: number;
+                psu2_voltage?: number;
+            };
+        }
+        namespace V7 {
+            type Health = {
+                cpu_temperature: number;
+                sfp_temperature: number;
+                switch_temperature: number;
+                fan_state: string;
+                fan1_speed: number;
+                fan2_speed: number;
+                board_temperature1: number;
+                board_temperature2: number;
+                psu1_state: string;
+                psu2_state: string;
+            };
+        }
+    }
+}
+export default Mikrotik;

package/dist/index.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright (c) 2024, Brandon Lehmann <brandonlehmann@gmail.com>
+// Copyright (c) 2024-2025, Brandon Lehmann <brandonlehmann@gmail.com>
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal
@@ -18,29 +18,6 @@
 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
-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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 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) {
@@ -54,15 +31,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AbortSignal = exports.AbortController = void 0;
-const ssh_1 = __importStar(require("@gibme/ssh"));
-Object.defineProperty(exports, "AbortController", { enumerable: true, get: function () { return ssh_1.AbortController; } });
-Object.defineProperty(exports, "AbortSignal", { enumerable: true, get: function () { return ssh_1.AbortSignal; } });
-const types_1 = require("./types");
+exports.Mikrotik = exports.AbortSignal = exports.AbortController = void 0;
+const ssh_1 = __importDefault(require("@gibme/ssh"));
 const ip_address_1 = require("ip-address");
 const memory_1 = __importDefault(require("@gibme/cache/memory"));
 const dns_1 = require("dns");
 const semver_1 = require("semver");
+const abort_controller_1 = require("abort-controller");
+Object.defineProperty(exports, "AbortController", { enumerable: true, get: function () { return abort_controller_1.AbortController; } });
+Object.defineProperty(exports, "AbortSignal", { enumerable: true, get: function () { return abort_controller_1.AbortSignal; } });
 /** @ignore */
 const toVersion = (version) => (0, semver_1.valid)((0, semver_1.coerce)(version)) || version;
 /** @ignore */
@@ -292,14 +269,12 @@ class Mikrotik extends ssh_1.default {
     bandwidth_test(target_1, username_1, password_1) {
         return __awaiter(this, arguments, void 0, function* (target, username, password, options = {}) {
             var _a;
-            // eslint-disable-next-line @typescript-eslint/no-this-alias
-            const $ = this;
             const sleep = (timeout) => __awaiter(this, void 0, void 0, function* () { return new Promise(resolve => setTimeout(resolve, timeout)); });
-            const controller = new ssh_1.AbortController();
+            const controller = new abort_controller_1.AbortController();
             (_a = options.signal) !== null && _a !== void 0 ? _a : (options.signal = controller.signal);
             // eslint-disable-next-line no-async-promise-executor
             return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
-                var _a, _b, _c, _d, _e;
+                var _a, _b, _c, _d, _e, _f;
                 (_a = options.duration) !== null && _a !== void 0 ? _a : (options.duration = 15);
                 (_b = options.direction) !== null && _b !== void 0 ? _b : (options.direction = 'both');
                 (_c = options.protocol) !== null && _c !== void 0 ? _c : (options.protocol = 'udp');
@@ -357,7 +332,7 @@ class Mikrotik extends ssh_1.default {
                  */
                 function handleStream(buffer) {
                     return __awaiter(this, void 0, void 0, function* () {
-                        const frame = new types_1.BandwidthTest.Frame(buffer).parse();
+                        const frame = new Mikrotik.BandwidthTest.Frame(buffer).parse();
                         const result = {
                             status: frame.status,
                             duration: parseInt(frame.duration) || 0,
@@ -389,10 +364,8 @@ class Mikrotik extends ssh_1.default {
                             case 'done testing':
                                 if (options.callback)
                                     options.callback(result);
-                                $.off('stream', handleStream);
                                 return resolve(result);
                             case 'authentication_failed':
-                                $.off('stream', handleStream);
                                 return reject(new Error('Authentication Failed'));
                             case 'connecting':
                             case 'running':
@@ -403,9 +376,7 @@ class Mikrotik extends ssh_1.default {
                         }
                     });
                 }
-                this.on('stream', handleStream);
                 const cleanup = () => __awaiter(this, void 0, void 0, function* () {
-                    this.off('stream', handleStream);
                     yield Mikrotik.cache.del(target);
                 });
                 yield Mikrotik.cache.set(target, target, options.duration); // set our mutex
@@ -419,21 +390,21 @@ class Mikrotik extends ssh_1.default {
                 if (options.remote_tx_speed) {
                     command += ` remote-tx-speed=${options.remote_tx_speed}M`;
                 }
-                yield this.stream(command, {
-                    separator: '\r\n\r\n',
-                    signal: options.signal
+                const stream = yield this.stream(command, { separator: '\r\n\r\n' });
+                (_f = options.signal) === null || _f === void 0 ? void 0 : _f.addEventListener('abort', () => {
+                    stream.abort();
                 });
-                this.once('stream_complete', () => __awaiter(this, void 0, void 0, function* () {
+                stream.on('data', handleStream);
+                stream.on('completed', () => __awaiter(this, void 0, void 0, function* () {
                     yield cleanup();
                 }));
-                this.once('stream_cancelled', () => __awaiter(this, void 0, void 0, function* () {
+                stream.on('cancelled', () => __awaiter(this, void 0, void 0, function* () {
                     yield cleanup();
                     return reject(new Error('Bandwidth Test Cancelled'));
                 }));
                 if (options.timeout) {
                     setTimeout(() => {
-                        var _a;
-                        (_a = options.signal) === null || _a === void 0 ? void 0 : _a.dispatchEvent(new Event('abort'));
+                        stream.abort();
                     }, options.timeout);
                 }
             }));
@@ -499,11 +470,16 @@ class Mikrotik extends ssh_1.default {
             const results = [];
             const resolveDNS = (ip) => __awaiter(this, void 0, void 0, function* () {
                 return new Promise(resolve => {
-                    (0, dns_1.reverse)(ip, (error, addresses) => {
-                        if (error)
-                            return resolve([ip, undefined]);
-                        return resolve([ip, addresses.shift()]);
-                    });
+                    try {
+                        (0, dns_1.reverse)(ip, (error, addresses) => {
+                            if (error)
+                                return resolve([ip, undefined]);
+                            return resolve([ip, addresses.shift()]);
+                        });
+                    }
+                    catch (_a) {
+                        return resolve([ip, undefined]);
+                    }
                 });
             });
             for (const [hop, address, loss, sent, last, avg, best, worst] of response) {
@@ -636,8 +612,8 @@ class Mikrotik extends ssh_1.default {
     health() {
         return __awaiter(this, void 0, void 0, function* () {
             const { major } = yield this.semantic_version();
-            const result = {};
             if (major === 6) {
+                const result = {};
                 const response = yield this.kvs('/system health print');
                 result.voltage = parseFloat(response.voltage) || 0;
                 result.current = parseFloat(response.current) || 0;
@@ -655,30 +631,41 @@ class Mikrotik extends ssh_1.default {
                 return result;
             }
             else if (major === 7) {
+                const result = {};
                 const response = yield this.terse('/system health print terse');
-                for (const { name, value, type } of response) {
+                for (const { name, value } of response) {
                     const num = parseFloat(value) || 0;
                     switch (name) {
-                        case 'voltage':
-                            result.voltage = num;
+                        case 'cpu-temperature':
+                            result.cpu_temperature = num;
                             break;
-                        case 'temperature':
-                            result.temperature = num;
+                        case 'sfp-temperature':
+                            result.sfp_temperature = num;
                             break;
-                        case 'power-consumption':
-                            result.power_consumption = num;
+                        case 'switch-temperature':
+                            result.switch_temperature = num;
                             break;
-                        case 'current':
-                            result.current = type === 'A' ? num * 1000 : num;
+                        case 'fan-state':
+                            result.fan_state = value;
                             break;
-                        case 'psu-voltage':
-                            result.psu_voltage = num;
+                        case 'fan1-speed':
+                            result.fan1_speed = num;
                             break;
-                        case 'psu1-voltage':
-                            result.psu1_voltage = num;
+                        case 'fan2-speed':
+                            result.fan2_speed = num;
+                            break;
+                        case 'board-temperature1':
+                            result.board_temperature1 = num;
+                            break;
+                        case 'board-temperature2':
+                            result.board_temperature2 = num;
+                            break;
+                        case 'psu1-state':
+                            result.psu1_state = value;
+                            break;
+                        case 'psu2-state':
+                            result.psu2_state = value;
                             break;
-                        case 'psu2-voltage':
-                            result.psu2_voltage = num;
                     }
                 }
                 return result;
@@ -782,8 +769,40 @@ class Mikrotik extends ssh_1.default {
         });
     }
 }
+exports.Mikrotik = Mikrotik;
 Mikrotik.cache = new memory_1.default({
     stdTTL: 15,
     checkperiod: 17
 });
+(function (Mikrotik) {
+    let BandwidthTest;
+    (function (BandwidthTest) {
+        /**
+         * Class that helps with processing a "frame" of the Bandwidth Test response
+         */
+        class Frame {
+            // eslint-disable-next-line no-useless-constructor
+            constructor(buffer) {
+                this.buffer = buffer;
+            }
+            parse() {
+                if (!this.parsed) {
+                    this.parsed = {};
+                    const records = this.buffer.toString('utf8').trim()
+                        .split('\n')
+                        .map(line => line.trim())
+                        .map(line => line.split(':', 2)
+                        .map(elem => elem.trim()));
+                    for (const [key, value] of records) {
+                        if (key.length === 0)
+                            continue;
+                        this.parsed[key.toLowerCase()] = value;
+                    }
+                }
+                return this.parsed;
+            }
+        }
+        BandwidthTest.Frame = Frame;
+    })(BandwidthTest = Mikrotik.BandwidthTest || (Mikrotik.BandwidthTest = {}));
+})(Mikrotik || (exports.Mikrotik = Mikrotik = {}));
 exports.default = Mikrotik;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gibme/mikrotik",
-  "version": "2.0.5",
+  "version": "3.0.0",
   "description": "A simple mikrotik helper/wrapper",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -30,7 +30,7 @@
   },
   "homepage": "https://gibme-npm.github.io/mikrotik/",
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "engineStrict": true,
   "author": {
@@ -39,7 +39,7 @@
   },
   "devDependencies": {
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.11.7",
+    "@types/node": "^22.15.17",
     "@typescript-eslint/eslint-plugin": "^6.19.1",
     "@typescript-eslint/parser": "^6.19.1",
     "dotenv": "^16.4.5",
@@ -51,14 +51,15 @@
     "eslint-plugin-promise": "^6.1.1",
     "mocha": "^10.2.0",
     "ts-node": "^10.9.2",
-    "typedoc": "^0.25.7",
-    "typescript": "^5.3.3"
+    "typedoc": "^0.28.4",
+    "typescript": "^5.8.3"
   },
   "dependencies": {
-    "@gibme/cache": "^1.1.5",
-    "@gibme/ssh": "^2.0.0",
+    "@gibme/cache": "^2.0.0",
+    "@gibme/ssh": "^3.0.1",
     "@types/jsbn": "^1.2.33",
-    "ip-address": "^9.0.5",
-    "semver": "^7.6.2"
+    "abort-controller": "^3.0.0",
+    "ip-address": "^10.0.1",
+    "semver": "^7.7.1"
   }
 }

package/dist/types.d.ts

@@ -1,246 +0,0 @@
-import type { AbortSignal } from 'abort-controller';
-export declare namespace BandwidthTest {
-    export type Direction = 'both' | 'transmit' | 'receive';
-    export type Protocol = 'udp' | 'tcp';
-    export type Status = 'running' | 'connecting' | 'done testing' | 'authentication_failed' | 'queued';
-    /**
-     * Class that helps with processing a "frame" of the Bandwidth Test response
-     */
-    export class Frame {
-        readonly buffer: Buffer;
-        private parsed?;
-        constructor(buffer: Buffer);
-        parse(): Record<string, string>;
-    }
-    interface DirectionStats {
-        current: number;
-        shortAverage: number;
-        totalAverage: number;
-        size: number;
-    }
-    export interface Update {
-        status: Status;
-        duration: number;
-        transmit?: DirectionStats;
-        receive?: DirectionStats;
-        lostPackets?: number;
-        randomData: boolean;
-        direction: Direction;
-        connectionCount: number;
-        localCPULoad: number;
-        remoteCPULoad: number;
-    }
-    export interface Options {
-        duration: number;
-        direction: Direction;
-        protocol: Protocol;
-        random_data: boolean;
-        callback: (frame: Update) => void;
-        timeout: number;
-        signal: AbortSignal;
-        /**
-         * In Megabits
-         */
-        local_tx_speed: number;
-        /**
-         * In Megabits
-         */
-        remote_tx_speed: number;
-    }
-    export {};
-}
-export declare namespace CommandResponses {
-    type YesNo = 'yes' | 'no';
-    interface Comment {
-        comment?: string;
-    }
-    interface Route extends Comment {
-        'dst-address': string;
-        gateway: string;
-        distance: string;
-        scope: string;
-        target_scope: string;
-        'routing-table'?: string;
-        'routing-mark'?: string;
-        'bgp-as-path'?: string;
-        'bgp-origin'?: string;
-        'bgp-local-pref'?: string;
-        'received-from'?: string;
-        'check-gateway'?: string;
-        'suppress-hw-offload'?: string;
-        'blackhole'?: string;
-        'immediate-gw'?: string;
-        reachable?: string;
-        'gateway-status'?: string;
-    }
-    interface Address extends Comment {
-        address: string;
-        network: string;
-        interface: string;
-        'actual-interface': string;
-    }
-    interface Interface extends Comment {
-        name: string;
-        type: string;
-        mtu: string;
-        'default-name'?: string;
-        'actual-mtu': string;
-        'mac-address'?: string;
-        'link-downs'?: string;
-        l2mtu?: string;
-    }
-    interface TunnelInterface extends Omit<Interface, 'type'>, Comment {
-        'local-address': string;
-        'remote-address': string;
-        'clamp-tcp-mss': YesNo;
-        'dont-fragment': YesNo;
-        'allow-fast-path': YesNo;
-    }
-    interface Routeboard {
-        routerboard: YesNo;
-        'board-name': string;
-        model: string;
-        'serial-number': string;
-        'firmware-type': string;
-        'factory-firmware': string;
-        'current-firmware': string;
-        'upgrade-firmware': string;
-    }
-    interface Identity {
-        name: string;
-    }
-    interface Resource {
-        uptime: string;
-        version: string;
-        'build-time': string;
-        'factory-software': string;
-        'free-memory': string;
-        'total-memory': string;
-        cpu: string;
-        'cpu-count': string;
-        'cpu-frequency': string;
-        'cpu-load': string;
-        'free-hdd-space': string;
-        'total-hdd-space': string;
-        'architecture-name': string;
-        'board-name': string;
-        platform: string;
-        'write-sect-since-reboot'?: string;
-        'write-sect-total'?: string;
-        'bad-blocks'?: string;
-    }
-    interface Health {
-        voltage: string;
-        current: string;
-        temperature: string;
-        'power-consumption': string;
-        'psu-voltage'?: string;
-        'psu1-voltage'?: string;
-        'psu2-voltage'?: string;
-    }
-}
-export declare namespace Response {
-    interface includesAddress {
-        includes(ipaddress: string): boolean;
-    }
-    interface Comment {
-        comment?: string;
-    }
-    export interface Address extends includesAddress, Comment {
-        ipaddress: string;
-        network: string;
-        cidr: number;
-        iface: string;
-    }
-    export interface Interface extends Comment {
-        name: string;
-        type: string;
-        local_address?: string;
-        remote_address?: string;
-    }
-    export interface Tunnel extends Interface {
-        parent: Address;
-    }
-    export interface Route extends includesAddress, Comment {
-        network: string;
-        cidr: number;
-        distance: number;
-        scope: number;
-        vrf: string;
-        preferred_source?: string;
-        gateway?: string;
-        iface?: string;
-        tunnel?: Tunnel;
-        target_scope?: number;
-    }
-    export interface RouteCount {
-        interface: string;
-        count: number;
-        active: boolean;
-    }
-    export interface Ping {
-        target: string;
-        latency: number;
-        source?: string;
-    }
-    export interface Traceroute {
-        hop: number;
-        loss: number;
-        sent: number;
-        last: number;
-        average: number;
-        best: number;
-        worst: number;
-        timeout: boolean;
-        address?: string;
-        hostname?: string;
-    }
-    export interface Routerboard {
-        routerboard: boolean;
-        board_name: string;
-        model: string;
-        serial_number: string;
-        firmware_type: string;
-        factory_firmware: string;
-        current_firmware: string;
-        upgrade_firmware: string;
-    }
-    export interface Resource {
-        uptime: string;
-        version: string;
-        build_time: Date;
-        factory_sofware: string;
-        free_memory: string;
-        total_memory: string;
-        cpu: string;
-        cpu_count: number;
-        cpu_frequency: number;
-        cpu_load: number;
-        hdd_space: {
-            free: string;
-            total: string;
-        };
-        architecture_name: string;
-        board_name: string;
-        platform: string;
-        lts?: boolean;
-        stable?: boolean;
-        testing?: boolean;
-        development?: boolean;
-        nvram?: {
-            write_since_reboot: number;
-            write_total: number;
-            bad_blocks: number;
-        };
-    }
-    export interface Health {
-        voltage: number;
-        current: number;
-        temperature: number;
-        power_consumption: number;
-        psu_voltage?: number;
-        psu1_voltage?: number;
-        psu2_voltage?: number;
-    }
-    export {};
-}

package/dist/types.js

@@ -1,51 +0,0 @@
-"use strict";
-// Copyright (c) 2024, Brandon Lehmann <brandonlehmann@gmail.com>
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in all
-// copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-// SOFTWARE.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BandwidthTest = void 0;
-var BandwidthTest;
-(function (BandwidthTest) {
-    /**
-     * Class that helps with processing a "frame" of the Bandwidth Test response
-     */
-    class Frame {
-        // eslint-disable-next-line no-useless-constructor
-        constructor(buffer) {
-            this.buffer = buffer;
-        }
-        parse() {
-            if (!this.parsed) {
-                this.parsed = {};
-                const records = this.buffer.toString('utf8').trim()
-                    .split('\n')
-                    .map(line => line.trim())
-                    .map(line => line.split(':', 2)
-                    .map(elem => elem.trim()));
-                for (const [key, value] of records) {
-                    if (key.length === 0)
-                        continue;
-                    this.parsed[key.toLowerCase()] = value;
-                }
-            }
-            return this.parsed;
-        }
-    }
-    BandwidthTest.Frame = Frame;
-})(BandwidthTest || (exports.BandwidthTest = BandwidthTest = {}));