rosinterface 1.3.6 → 1.4.0

package/dist/features/PPPoEWrapper.d.ts

@@ -0,0 +1,217 @@
+import { MikrotikClient, IWriteOptions } from "../client/MikrotikClient";
+export declare class PPPWrapper {
+    private client;
+    constructor(client: MikrotikClient);
+    /**
+     * **Retrieve: PPP Secrets (PRINT)**
+     *
+     * Sends a `/ppp/secret/print` command to list user accounts.
+     *
+     * **Feature: Filtered Search**
+     * You can pass a dictionary of parameters to filter the results directly on the router,
+     * reducing the amount of data transferred over the network.
+     *
+     * @param filter Optional dictionary to filter results (e.g., `{"?profile": "Plan_50M"}`).
+     * @param options Advanced write options (idempotency, forced protocol).
+     * @returns A promise resolving to an array of secret objects.
+     *
+     * @example
+     * ```typescript
+     * // Get all users
+     * const allUsers = await mk.ppp.getSecrets();
+     * * // Get users assigned to a specific profile
+     * const basicUsers = await mk.ppp.getSecrets({ "?profile": "Plan_20M" });
+     * ```
+     */
+    getSecrets(filter?: Record<string, string>, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Resource Creation: PPP Secret (ADD)**
+     *
+     * Sends a `/ppp/secret/add` command to create a new PPPoE user account.
+     *
+     * **Feature: Account Provisioning**
+     * Essential for onboarding new clients, allowing you to specify their
+     * authentication credentials and link them to a specific bandwidth profile.
+     *
+     * @param name The username for the PPPoE connection.
+     * @param password The password for the connection.
+     * @param profile The PPP profile (plan) to assign. Defaults to 'default'.
+     * @param service The service type. Defaults to 'pppoe'.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Add a new client with a specific plan
+     * await mk.ppp.addSecret('john_doe', 'securePass123', 'Plan_50M');
+     * ```
+     */
+    addSecret(name: string, password: string, profile?: string, service?: string, additionalParams?: Record<string, string | boolean | number>, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Resource Modification: Update Secret (SET)**
+     *
+     * Sends a `/ppp/secret/set` command to modify an existing user account.
+     *
+     * **Feature: Dynamic Provisioning**
+     * Automatically resolves the internal `.id` based on the username and applies
+     * the new parameters. Useful for changing passwords or upgrading plans.
+     *
+     * @param name The exact username of the secret to modify.
+     * @param paramsToUpdate Dictionary containing the fields to update.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Upgrade a user's plan and change their password
+     * await mk.ppp.setSecret('john_doe', {
+     * profile: 'Plan_100M',
+     * password: 'newPassword456'
+     * });
+     * ```
+     */
+    setSecret(name: string, paramsToUpdate: Record<string, string | boolean | number>, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **State Modification: Enable Secret (ENABLE)**
+     *
+     * Sends a `/ppp/secret/enable` command to activate a previously disabled account.
+     *
+     * **Feature: Service Reactivation**
+     * Restores access for a client, typically used automatically after an invoice is paid.
+     *
+     * @param name The username to enable.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Reactivate service for a user who paid their invoice
+     * await mk.ppp.enableSecret('john_doe');
+     * ```
+     */
+    enableSecret(name: string, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **State Modification: Disable Secret (DISABLE)**
+     *
+     * Sends a `/ppp/secret/disable` command to suspend a user account.
+     *
+     * **Feature: Service Suspension**
+     * Prevents the user from authenticating. Does not drop active connections
+     * automatically (use `killActiveSession` for that).
+     *
+     * @param name The username to disable.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Suspend a user for non-payment
+     * await mk.ppp.disableSecret('john_doe');
+     * * // Note: To immediately drop their connection, call killActiveSession() after this.
+     * ```
+     */
+    disableSecret(name: string, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Execution Terminator: Delete Secret (REMOVE)**
+     *
+     * Sends a `/ppp/secret/remove` command to permanently delete a user account.
+     *
+     * **Feature: Safe Deletion**
+     * Searches for the exact dynamic ID before attempting removal, preventing errors.
+     *
+     * @param name The username to delete.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Delete a user who canceled their subscription
+     * try {
+     * await mk.ppp.removeSecret('john_doe');
+     * console.log('User deleted successfully');
+     * } catch (error) {
+     * console.error(error.message);
+     * }
+     * ```
+     */
+    removeSecret(name: string, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Retrieve: Active Sessions (PRINT)**
+     *
+     * Sends a `/ppp/active/print` command to list currently connected sessions.
+     *
+     * **Feature: Real-time Monitoring**
+     * Allows you to check who is currently authenticated and connected to the router.
+     *
+     * @param filter Optional dictionary to filter results (e.g., searching by IP).
+     * @param options Advanced write options.
+     * @returns A promise resolving to an array of active connection objects.
+     *
+     * @example
+     * ```typescript
+     * // Check if a specific user is currently online
+     * const activeSessions = await mk.ppp.getActiveConnections({ "?name": "john_doe" });
+     * const isOnline = activeSessions.length > 0;
+     * ```
+     */
+    getActiveConnections(filter?: Record<string, string>, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Execution Terminator: Disconnect Session (REMOVE)**
+     *
+     * Sends a `/ppp/active/remove` command to force an active session to disconnect.
+     *
+     * **Feature: Session Management**
+     * Ideal for forcing a reconnection after changing a profile, upgrading bandwidth,
+     * or suspending service, ensuring the new rules apply immediately.
+     *
+     * @param name The username of the active session to disconnect.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response, or false if the user wasn't active.
+     *
+     * @example
+     * ```typescript
+     * // Suspend user and immediately drop their current session
+     * await mk.ppp.disableSecret('john_doe');
+     * await mk.ppp.killActiveSession('john_doe');
+     * ```
+     */
+    killActiveSession(name: string, options?: IWriteOptions): Promise<false | any[]>;
+    /**
+     * **Retrieve: PPP Profiles (PRINT)**
+     *
+     * Sends a `/ppp/profile/print` command to list existing service plans.
+     *
+     * @param filter Optional dictionary to filter results.
+     * @param options Advanced write options.
+     * @returns A promise resolving to an array of profile objects.
+     *
+     * @example
+     * ```typescript
+     * // Get all configured plans on the router
+     * const profiles = await mk.ppp.getProfiles();
+     * ```
+     */
+    getProfiles(filter?: Record<string, string>, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Resource Creation: PPP Profile (ADD)**
+     *
+     * Sends a `/ppp/profile/add` command to create a new service plan.
+     *
+     * **Feature: Bandwidth Allocation**
+     * Defines a centralized template for speed limits and routing rules that
+     * can be assigned to multiple PPPoE secrets.
+     *
+     * @param name The name of the new profile.
+     * @param rateLimit The bandwidth limit format (Rx/Tx) e.g., '10M/20M'.
+     * @param localAddress The local IP address for the tunnel endpoint. Defaults to '192.168.89.1'.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Create a 50 Megabit download / 20 Megabit upload plan
+     * await mk.ppp.addProfile('Plan_50M', '20M/50M', '10.0.0.1');
+     * ```
+     */
+    addProfile(name: string, rateLimit: string, localAddress?: string, options?: IWriteOptions): Promise<any[]>;
+}

package/dist/features/PPPoEWrapper.js

@@ -0,0 +1,293 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PPPWrapper = void 0;
+class PPPWrapper {
+    constructor(client) {
+        this.client = client;
+    }
+    // ==========================================
+    // SECRETS (User Management)
+    // ==========================================
+    /**
+     * **Retrieve: PPP Secrets (PRINT)**
+     *
+     * Sends a `/ppp/secret/print` command to list user accounts.
+     *
+     * **Feature: Filtered Search**
+     * You can pass a dictionary of parameters to filter the results directly on the router,
+     * reducing the amount of data transferred over the network.
+     *
+     * @param filter Optional dictionary to filter results (e.g., `{"?profile": "Plan_50M"}`).
+     * @param options Advanced write options (idempotency, forced protocol).
+     * @returns A promise resolving to an array of secret objects.
+     *
+     * @example
+     * ```typescript
+     * // Get all users
+     * const allUsers = await mk.ppp.getSecrets();
+     * * // Get users assigned to a specific profile
+     * const basicUsers = await mk.ppp.getSecrets({ "?profile": "Plan_20M" });
+     * ```
+     */
+    async getSecrets(filter, options) {
+        return this.client.write('/ppp/secret/print', filter || {}, options);
+    }
+    /**
+     * **Resource Creation: PPP Secret (ADD)**
+     *
+     * Sends a `/ppp/secret/add` command to create a new PPPoE user account.
+     *
+     * **Feature: Account Provisioning**
+     * Essential for onboarding new clients, allowing you to specify their
+     * authentication credentials and link them to a specific bandwidth profile.
+     *
+     * @param name The username for the PPPoE connection.
+     * @param password The password for the connection.
+     * @param profile The PPP profile (plan) to assign. Defaults to 'default'.
+     * @param service The service type. Defaults to 'pppoe'.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Add a new client with a specific plan
+     * await mk.ppp.addSecret('john_doe', 'securePass123', 'Plan_50M');
+     * ```
+     */
+    async addSecret(name, password, profile = 'default', service = 'pppoe', additionalParams, options) {
+        return this.client.write('/ppp/secret/add', {
+            name,
+            password,
+            profile,
+            service,
+            ...additionalParams
+        }, options);
+    }
+    /**
+     * **Resource Modification: Update Secret (SET)**
+     *
+     * Sends a `/ppp/secret/set` command to modify an existing user account.
+     *
+     * **Feature: Dynamic Provisioning**
+     * Automatically resolves the internal `.id` based on the username and applies
+     * the new parameters. Useful for changing passwords or upgrading plans.
+     *
+     * @param name The exact username of the secret to modify.
+     * @param paramsToUpdate Dictionary containing the fields to update.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Upgrade a user's plan and change their password
+     * await mk.ppp.setSecret('john_doe', {
+     * profile: 'Plan_100M',
+     * password: 'newPassword456'
+     * });
+     * ```
+     */
+    async setSecret(name, paramsToUpdate, options) {
+        const result = await this.getSecrets({ "?name": name }, options);
+        if (result.length > 0 && result[0]['.id']) {
+            return this.client.write('/ppp/secret/set', {
+                ".id": result[0]['.id'],
+                ...paramsToUpdate // Inject new values
+            }, options);
+        }
+        throw new Error(`PPP Secret '${name}' not found.`);
+    }
+    /**
+     * **State Modification: Enable Secret (ENABLE)**
+     *
+     * Sends a `/ppp/secret/enable` command to activate a previously disabled account.
+     *
+     * **Feature: Service Reactivation**
+     * Restores access for a client, typically used automatically after an invoice is paid.
+     *
+     * @param name The username to enable.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Reactivate service for a user who paid their invoice
+     * await mk.ppp.enableSecret('john_doe');
+     * ```
+     */
+    async enableSecret(name, options) {
+        const result = await this.getSecrets({ "?name": name }, options);
+        if (result.length > 0 && result[0]['.id']) {
+            return this.client.write('/ppp/secret/enable', {
+                ".id": result[0]['.id']
+            }, options);
+        }
+        throw new Error(`PPP Secret '${name}' not found.`);
+    }
+    /**
+     * **State Modification: Disable Secret (DISABLE)**
+     *
+     * Sends a `/ppp/secret/disable` command to suspend a user account.
+     *
+     * **Feature: Service Suspension**
+     * Prevents the user from authenticating. Does not drop active connections
+     * automatically (use `killActiveSession` for that).
+     *
+     * @param name The username to disable.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Suspend a user for non-payment
+     * await mk.ppp.disableSecret('john_doe');
+     * * // Note: To immediately drop their connection, call killActiveSession() after this.
+     * ```
+     */
+    async disableSecret(name, options) {
+        const result = await this.getSecrets({ "?name": name }, options);
+        if (result.length > 0 && result[0]['.id']) {
+            return this.client.write('/ppp/secret/disable', {
+                ".id": result[0]['.id']
+            }, options);
+        }
+        throw new Error(`PPP Secret '${name}' not found.`);
+    }
+    /**
+     * **Execution Terminator: Delete Secret (REMOVE)**
+     *
+     * Sends a `/ppp/secret/remove` command to permanently delete a user account.
+     *
+     * **Feature: Safe Deletion**
+     * Searches for the exact dynamic ID before attempting removal, preventing errors.
+     *
+     * @param name The username to delete.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Delete a user who canceled their subscription
+     * try {
+     * await mk.ppp.removeSecret('john_doe');
+     * console.log('User deleted successfully');
+     * } catch (error) {
+     * console.error(error.message);
+     * }
+     * ```
+     */
+    async removeSecret(name, options) {
+        const result = await this.getSecrets({ "?name": name }, options);
+        if (result.length > 0 && result[0]['.id']) {
+            return this.client.write('/ppp/secret/remove', {
+                ".id": result[0]['.id']
+            }, options);
+        }
+        throw new Error(`PPP Secret '${name}' not found.`);
+    }
+    // ==========================================
+    // ACTIVE (Active Sessions Management)
+    // ==========================================
+    /**
+     * **Retrieve: Active Sessions (PRINT)**
+     *
+     * Sends a `/ppp/active/print` command to list currently connected sessions.
+     *
+     * **Feature: Real-time Monitoring**
+     * Allows you to check who is currently authenticated and connected to the router.
+     *
+     * @param filter Optional dictionary to filter results (e.g., searching by IP).
+     * @param options Advanced write options.
+     * @returns A promise resolving to an array of active connection objects.
+     *
+     * @example
+     * ```typescript
+     * // Check if a specific user is currently online
+     * const activeSessions = await mk.ppp.getActiveConnections({ "?name": "john_doe" });
+     * const isOnline = activeSessions.length > 0;
+     * ```
+     */
+    async getActiveConnections(filter, options) {
+        return this.client.write('/ppp/active/print', filter || {}, options);
+    }
+    /**
+     * **Execution Terminator: Disconnect Session (REMOVE)**
+     *
+     * Sends a `/ppp/active/remove` command to force an active session to disconnect.
+     *
+     * **Feature: Session Management**
+     * Ideal for forcing a reconnection after changing a profile, upgrading bandwidth,
+     * or suspending service, ensuring the new rules apply immediately.
+     *
+     * @param name The username of the active session to disconnect.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response, or false if the user wasn't active.
+     *
+     * @example
+     * ```typescript
+     * // Suspend user and immediately drop their current session
+     * await mk.ppp.disableSecret('john_doe');
+     * await mk.ppp.killActiveSession('john_doe');
+     * ```
+     */
+    async killActiveSession(name, options) {
+        const result = await this.getActiveConnections({ "?name": name }, options);
+        if (result.length > 0 && result[0]['.id']) {
+            return this.client.write('/ppp/active/remove', {
+                ".id": result[0]['.id']
+            }, options);
+        }
+        // If the user is not active, the objective is already met
+        return false;
+    }
+    // ==========================================
+    // PROFILES (Plan Management)
+    // ==========================================
+    /**
+     * **Retrieve: PPP Profiles (PRINT)**
+     *
+     * Sends a `/ppp/profile/print` command to list existing service plans.
+     *
+     * @param filter Optional dictionary to filter results.
+     * @param options Advanced write options.
+     * @returns A promise resolving to an array of profile objects.
+     *
+     * @example
+     * ```typescript
+     * // Get all configured plans on the router
+     * const profiles = await mk.ppp.getProfiles();
+     * ```
+     */
+    async getProfiles(filter, options) {
+        return this.client.write('/ppp/profile/print', filter || {}, options);
+    }
+    /**
+     * **Resource Creation: PPP Profile (ADD)**
+     *
+     * Sends a `/ppp/profile/add` command to create a new service plan.
+     *
+     * **Feature: Bandwidth Allocation**
+     * Defines a centralized template for speed limits and routing rules that
+     * can be assigned to multiple PPPoE secrets.
+     *
+     * @param name The name of the new profile.
+     * @param rateLimit The bandwidth limit format (Rx/Tx) e.g., '10M/20M'.
+     * @param localAddress The local IP address for the tunnel endpoint. Defaults to '192.168.89.1'.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Create a 50 Megabit download / 20 Megabit upload plan
+     * await mk.ppp.addProfile('Plan_50M', '20M/50M', '10.0.0.1');
+     * ```
+     */
+    async addProfile(name, rateLimit, localAddress = '192.168.89.1', options) {
+        return this.client.write('/ppp/profile/add', {
+            name,
+            "local-address": localAddress,
+            "rate-limit": rateLimit
+        }, options);
+    }
+}
+exports.PPPWrapper = PPPWrapper;
+//# sourceMappingURL=PPPoEWrapper.js.map

package/dist/features/PPPoEWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PPPoEWrapper.js","sourceRoot":"","sources":["../../src/features/PPPoEWrapper.ts"],"names":[],"mappings":";;;AAEA,MAAa,UAAU;IAGnB,YAAY,MAAsB;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,6CAA6C;IAC7C,4BAA4B;IAC5B,6CAA6C;IAE7C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,UAAU,CAAC,MAA+B,EAAE,OAAuB;QACrE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,SAAS,CACX,IAAY,EACZ,QAAgB,EAChB,UAAkB,SAAS,EAC3B,UAAkB,OAAO,EACzB,gBAA4D,EAC5D,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iBAAiB,EAAE;YACxC,IAAI;YACJ,QAAQ;YACR,OAAO;YACP,OAAO;YACP,GAAG,gBAAgB;SACtB,EAAE,OAAO,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,SAAS,CACX,IAAY,EACZ,cAAyD,EACzD,OAAuB;QAEvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QAEjE,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iBAAiB,EAAE;gBACxC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;gBACvB,GAAG,cAAc,CAAC,oBAAoB;aACzC,EAAE,OAAO,CAAC,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,eAAe,IAAI,cAAc,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,OAAuB;QACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QAEjE,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,EAAE;gBAC3C,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;aAC1B,EAAE,OAAO,CAAC,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,eAAe,IAAI,cAAc,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,OAAuB;QACrD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QAEjE,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE;gBAC5C,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;aAC1B,EAAE,OAAO,CAAC,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,eAAe,IAAI,cAAc,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,OAAuB;QACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QAEjE,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,EAAE;gBAC3C,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;aAC1B,EAAE,OAAO,CAAC,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,eAAe,IAAI,cAAc,CAAC,CAAC;IACvD,CAAC;IAED,6CAA6C;IAC7C,sCAAsC;IACtC,6CAA6C;IAE7C;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,oBAAoB,CAAC,MAA+B,EAAE,OAAuB;QAC/E,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,iBAAiB,CAAC,IAAY,EAAE,OAAuB;QACzD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QAE3E,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,EAAE;gBAC3C,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;aAC1B,EAAE,OAAO,CAAC,CAAC;QAChB,CAAC;QACD,0DAA0D;QAC1D,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,6CAA6C;IAC7C,6BAA6B;IAC7B,6CAA6C;IAE7C;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,WAAW,CAAC,MAA+B,EAAE,OAAuB;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,UAAU,CACZ,IAAY,EACZ,SAAiB,EACjB,eAAuB,cAAc,EACrC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE;YACzC,IAAI;YACJ,eAAe,EAAE,YAAY;YAC7B,YAAY,EAAE,SAAS;SAC1B,EAAE,OAAO,CAAC,CAAC;IAChB,CAAC;CACJ;AAnUD,gCAmUC"}

package/dist/features/QueueWrapper.d.ts

@@ -0,0 +1,118 @@
+import { MikrotikClient, IWriteOptions } from "../client/MikrotikClient";
+export declare class QueueWrapper {
+    private client;
+    constructor(client: MikrotikClient);
+    /**
+     * **Retrieve: Simple Queues (PRINT)**
+     *
+     * Sends a `/queue/simple/print` command to list bandwidth queues.
+     *
+     * **Feature: Filtered Search**
+     * You can pass a dictionary of parameters to filter the results directly on the router,
+     * reducing network overhead and processing time.
+     *
+     * @param filter Optional dictionary to filter results (e.g., `{"?target": "192.168.10.50/32"}`).
+     * @param options Advanced write options (idempotency, forced protocol).
+     * @returns A promise resolving to an array of queue objects.
+     *
+     * @example
+     * ```typescript
+     * // Get all configured queues
+     * const allQueues = await mk.queue.getQueues();
+     * * // Find a specific queue by its target IP
+     * const clientQueue = await mk.queue.getQueues({ "?target": "192.168.10.50/32" });
+     * ```
+     */
+    getQueues(filter?: Record<string, string>, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Resource Creation: Simple Queue (ADD)**
+     *
+     * Sends a `/queue/simple/add` command to limit bandwidth for a specific target.
+     *
+     * **Feature: Bandwidth Allocation (QoS)**
+     * Creates basic rules to limit upload and download speeds. You can also pass
+     * additional parameters to build hierarchical QoS trees.
+     *
+     * @param name The identifier name for the queue (e.g., 'Client_John').
+     * @param target The target IP address or subnet (e.g., '192.168.10.50/32').
+     * @param maxLimit The maximum bandwidth allowed format (Upload/Download) e.g., '10M/20M'.
+     * @param additionalParams Optional dictionary for extra parameters like priority, parent queue, etc.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Create a 20 Megabit download / 10 Megabit upload limit for a single IP
+     * await mk.queue.addQueue('Client_John', '192.168.10.50/32', '10M/20M');
+     * * // Create a queue with a specific parent for hierarchical QoS
+     * await mk.queue.addQueue('Client_Jane', '192.168.10.51/32', '5M/10M', { parent: 'Main_Node' });
+     * ```
+     */
+    addQueue(name: string, target: string, maxLimit: string, additionalParams?: Record<string, string | boolean | number>, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Resource Modification: Update Queue (SET)**
+     *
+     * Sends a `/queue/simple/set` command to modify an existing Simple Queue.
+     *
+     * **Feature: Dynamic Speed Adjustment**
+     * Automatically resolves the internal `.id` based on the target IP and applies
+     * the new parameters, allowing for on-the-fly plan upgrades/downgrades.
+     *
+     * @param target The exact target IP or subnet of the queue to modify.
+     * @param paramsToUpdate Dictionary containing the fields to update (e.g., `{"max-limit": "50M/100M"}`).
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Upgrade a user's bandwidth on the fly
+     * await mk.queue.setQueueLimit('192.168.10.50/32', { "max-limit": "20M/50M" });
+     * ```
+     */
+    setQueueLimit(target: string, paramsToUpdate: Record<string, string | boolean | number>, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Execution Terminator: Delete Queue (REMOVE)**
+     *
+     * Sends a `/queue/simple/remove` command to permanently delete a Simple Queue.
+     *
+     * **Feature: Safe Deletion**
+     * Searches for the exact dynamic ID before attempting removal, preventing errors
+     * if the queue does not exist.
+     *
+     * @param target The exact target IP or subnet of the queue to delete.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Remove bandwidth limits for a specific IP
+     * try {
+     * await mk.queue.removeQueue('192.168.10.50/32');
+     * console.log('Queue removed successfully');
+     * } catch (error) {
+     * console.error(error.message);
+     * }
+     * ```
+     */
+    removeQueue(target: string, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Execution: Reset Statistics (RESET-COUNTERS)**
+     *
+     * Sends a `/queue/simple/reset-counters` command to clear traffic data.
+     *
+     * **Feature: Traffic Monitoring Reset**
+     * Useful for billing cycles or data cap management when you need to reset
+     * the bytes/packets counted by the router for a specific target.
+     *
+     * @param target The exact target IP or subnet of the queue to reset.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Reset traffic statistics at the beginning of a billing cycle
+     * await mk.queue.resetCounters('192.168.10.50/32');
+     * ```
+     */
+    resetCounters(target: string, options?: IWriteOptions): Promise<any[]>;
+}