@gibme/mikrotik 2.0.1 → 2.0.3

package/dist/index.d.ts

@@ -1,6 +1,7 @@
-import SSH from '@gibme/ssh';
+import SSH, { AbortController, AbortSignal } from '@gibme/ssh';
 import { BandwidthTest, Response } from './types';
 import Cache from '@gibme/cache/memory';
+export { AbortController, AbortSignal };
 export type { ConnectConfig } from '@gibme/ssh';
 export type Direction = BandwidthTest.Direction;
 export type Protocol = BandwidthTest.Protocol;
@@ -108,12 +109,12 @@ export default class Mikrotik extends SSH {
      * @param command
      * @protected
      */
-    protected terse<Type extends object = any>(command: string): Promise<Type[]>;
+    terse<Type extends object = any>(command: string): Promise<Type[]>;
     /**
      * Executes a command that expects the result as a 'table' of key-value pairs separated by a colon (:)
      *
      * @param command
      * @protected
      */
-    protected kvs<Type extends object = any>(command: string): Promise<Type>;
+    kvs<Type extends object = any>(command: string): Promise<Type>;
 }

package/dist/index.js

@@ -18,6 +18,29 @@
 // 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) {
@@ -31,7 +54,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const ssh_1 = __importDefault(require("@gibme/ssh"));
+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");
 const ip_address_1 = require("ip-address");
 const memory_1 = __importDefault(require("@gibme/cache/memory"));
@@ -265,9 +291,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();
+            (_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;
@@ -380,11 +409,19 @@ class Mikrotik extends ssh_1.default {
                     yield Mikrotik.cache.del(target);
                 });
                 yield Mikrotik.cache.set(target, target, options.duration); // set our mutex
-                const cancel = yield this.stream(`/tool bandwidth-test protocol=${options.protocol} ` +
+                let command = `/tool bandwidth-test protocol=${options.protocol} ` +
                     `user=${username} password=${password} ` +
                     `duration=${options.duration}s direction=${options.direction} ` +
-                    `address=${target} random-data=${options.random_data ? 'yes' : 'no'} interval=1s`, {
-                    separator: '\r\n\r\n'
+                    `address=${target} random-data=${options.random_data ? 'yes' : 'no'} interval=1s`;
+                if (options.local_tx_speed) {
+                    command += ` local-tx-speed=${options.local_tx_speed}M`;
+                }
+                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
                 });
                 this.once('stream_complete', () => __awaiter(this, void 0, void 0, function* () {
                     yield cleanup();
@@ -394,7 +431,10 @@ class Mikrotik extends ssh_1.default {
                     return reject(new Error('Bandwidth Test Cancelled'));
                 }));
                 if (options.timeout) {
-                    setTimeout(cancel, options.timeout);
+                    setTimeout(() => {
+                        var _a;
+                        (_a = options.signal) === null || _a === void 0 ? void 0 : _a.dispatchEvent(new Event('abort'));
+                    }, options.timeout);
                 }
             }));
         });

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import type { AbortSignal } from 'abort-controller';
 export declare namespace BandwidthTest {
     export type Direction = 'both' | 'transmit' | 'receive';
     export type Protocol = 'udp' | 'tcp';
@@ -36,6 +37,15 @@ export declare namespace BandwidthTest {
         random_data: boolean;
         callback: (frame: Update) => void;
         timeout: number;
+        signal: AbortSignal;
+        /**
+         * In Megabits
+         */
+        local_tx_speed: number;
+        /**
+         * In Megabits
+         */
+        remote_tx_speed: number;
     }
     export {};
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gibme/mikrotik",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "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.3",
+    "@gibme/ssh": "^2.0.0",
     "@types/jsbn": "^1.2.33",
     "ip-address": "^9.0.5",
     "semver": "^7.6.2"