@gibme/mikrotik 1.0.1 → 1.1.0

package/dist/index.d.ts

@@ -1,7 +1,18 @@
 import SSH from '@gibme/ssh';
 import { BandwidthTest, Response } from './types';
 import Cache from '@gibme/cache/memory';
-export { BandwidthTest };
+export { 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 Route = Response.Route;
+export type RouteCount = Response.RouteCount;
+export type Ping = Response.Ping;
+export type Traceroute = Response.Traceroute;
 export default class Mikrotik extends SSH {
     protected static cache: Cache;
     /**
@@ -10,15 +21,15 @@ export default class Mikrotik extends SSH {
      * @param min_distance
      * @param vrf
      */
-    get_ip_routes(min_distance?: number, vrf?: string): Promise<Response.Route[]>;
+    get_ip_routes(min_distance?: number, vrf?: string): Promise<Route[]>;
     /**
      * Retrieves the IP addresses active on the system
      */
-    get_ip_addresses(): Promise<Response.Address[]>;
+    get_ip_addresses(): Promise<Address[]>;
     /**
      * Retrieves the interfaces active on the system
      */
-    get_interfaces(): Promise<Response.Interface[]>;
+    get_interfaces(): Promise<Interface[]>;
     /**
      * For all device IP addresses, counts the routes that exit (either directly or tunneled)
      * the device using each IP address
@@ -26,7 +37,7 @@ export default class Mikrotik extends SSH {
      * @param min_distance
      * @param vrf
      */
-    get_route_counts(min_distance?: number, vrf?: string): Promise<Record<string, Response.RouteCount>>;
+    get_route_counts(min_distance?: number, vrf?: string): Promise<Record<string, RouteCount>>;
     /**
      * Executes a bandwidth test
      *
@@ -39,21 +50,21 @@ export default class Mikrotik extends SSH {
      * @param password
      * @param options
      */
-    bandwidth_test(target: string, username: string, password: string, options?: Partial<BandwidthTest.Options>): Promise<BandwidthTest.Update>;
+    bandwidth_test(target: string, username: string, password: string, options?: Partial<Options>): Promise<Update>;
     /**
      * Pings the target IP address from the source IP address (if supplied)
      *
      * @param target
      * @param source
      */
-    ping(target: string, source?: string): Promise<Response.Ping>;
+    ping(target: string, source?: string): Promise<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<Response.Traceroute[]>;
+    traceroute(target: string, source?: string): Promise<Traceroute[]>;
     /**
      * Executes a command with expected terse response and parses it accordingly
      *

package/dist/index.js

@@ -31,10 +31,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BandwidthTest = void 0;
 const ssh_1 = __importDefault(require("@gibme/ssh"));
 const types_1 = require("./types");
-Object.defineProperty(exports, "BandwidthTest", { enumerable: true, get: function () { return types_1.BandwidthTest; } });
 const ip_1 = __importDefault(require("ip"));
 const memory_1 = __importDefault(require("@gibme/cache/memory"));
 const dns_1 = require("dns");
@@ -228,8 +226,7 @@ class Mikrotik extends ssh_1.default {
             direction: 'both',
             protocol: 'udp',
             random_data: false,
-            callback: () => {
-            }
+            callback: () => { }
         }) {
             // eslint-disable-next-line @typescript-eslint/no-this-alias
             const $ = this;
@@ -241,8 +238,7 @@ class Mikrotik extends ssh_1.default {
                 (_b = options.direction) !== null && _b !== void 0 ? _b : (options.direction = 'both');
                 (_c = options.protocol) !== null && _c !== void 0 ? _c : (options.protocol = 'udp');
                 (_d = options.random_data) !== null && _d !== void 0 ? _d : (options.random_data = false);
-                (_e = options.callback) !== null && _e !== void 0 ? _e : (options.callback = () => {
-                });
+                (_e = options.callback) !== null && _e !== void 0 ? _e : (options.callback = () => { });
                 /**
                  * This serves as a lazy "mutex" that prevents us from running
                  * a bandwidth test for against a target host that is already
@@ -342,8 +338,7 @@ class Mikrotik extends ssh_1.default {
                     });
                 }
                 this.on('stream', handleStream);
-                // set our mutex
-                yield Mikrotik.cache.set(target, target, options.duration);
+                yield Mikrotik.cache.set(target, target, options.duration); // set our mutex
                 yield this.stream(`/tool bandwidth-test protocol=${options.protocol} ` +
                     `user=${username} password=${password} ` +
                     `duration=${options.duration}s direction=${options.direction} ` +

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gibme/mikrotik",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "A simple mikrotik helper/wrapper",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -56,7 +56,7 @@
   },
   "dependencies": {
     "@gibme/cache": "^1.1.5",
-    "@gibme/ssh": "^1.0.0",
+    "@gibme/ssh": "^1.0.1",
     "@types/ip": "^1.1.3",
     "ip": "^2.0.1"
   }