rosinterface 1.3.6 → 1.4.0

package/dist/features/FirewallWrapper.js

@@ -0,0 +1,272 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FirewallWrapper = void 0;
+class FirewallWrapper {
+    constructor(client) {
+        this.client = client;
+    }
+    // ==========================================
+    // ADDRESS LISTS (Client Isolation & Grouping)
+    // ==========================================
+    /**
+     * **Retrieve: Address Lists (PRINT)**
+     *
+     * Sends an `/ip/firewall/address-list/print` command to retrieve IP groupings.
+     *
+     * **Feature: Filtered Search**
+     * Highly useful for checking if a specific customer IP is currently flagged
+     * in a suspension or walled-garden list.
+     *
+     * @param filter Optional dictionary to filter results.
+     * @param options Advanced write options.
+     * @returns A promise resolving to an array of address list entries.
+     *
+     * @example
+     * ```typescript
+     * // 1. Get all IPs currently in the "suspended_users" list
+     * const suspended = await mk.firewall.getAddressLists({ "?list": "suspended_users" });
+     * * // 2. Check which lists a specific IP belongs to
+     * const userLists = await mk.firewall.getAddressLists({ "?address": "192.168.20.50" });
+     * ```
+     */
+    async getAddressLists(filter, options) {
+        return this.client.write('/ip/firewall/address-list/print', filter || {}, options);
+    }
+    /**
+     * **Resource Creation: Address List Entry (ADD)**
+     *
+     * Sends an `/ip/firewall/address-list/add` command to add an IP to a named list.
+     *
+     * **Feature: Dynamic Grouping & Timeouts**
+     * Essential for billing automation. You can add a client to a suspension list
+     * indefinitely, or use the `timeout` parameter for temporary bans.
+     *
+     * @param address The target IP address or subnet (e.g., '192.168.20.50').
+     * @param listName The name of the group (e.g., 'suspended_users').
+     * @param additionalParams Optional parameters like 'comment' or 'timeout'.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // 1. Suspend a user indefinitely for non-payment
+     * await mk.firewall.addAddressList('192.168.20.50', 'suspended_users', {
+     * comment: 'Invoice #1045 unpaid'
+     * });
+     * * // 2. Temporarily block an IP for 1 hour (e.g., due to suspicious activity)
+     * await mk.firewall.addAddressList('10.0.0.15', 'temp_blacklist', {
+     * timeout: '1h',
+     * comment: 'Auto-blocked: SSH brute force'
+     * });
+     * ```
+     */
+    async addAddressList(address, listName, additionalParams, options) {
+        return this.client.write('/ip/firewall/address-list/add', {
+            address,
+            list: listName,
+            ...additionalParams
+        }, options);
+    }
+    /**
+     * **Execution Terminator: Delete Address List Entry (REMOVE)**
+     *
+     * Sends an `/ip/firewall/address-list/remove` command.
+     *
+     * **Feature: Safe Deletion**
+     * Automatically resolves the dynamic `.id` based on the IP and List Name combination
+     * before attempting to remove it.
+     *
+     * @param address The IP address to remove.
+     * @param listName The name of the list from which to remove the IP.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // 1. Restore service by removing the IP from the suspended list
+     * await mk.firewall.removeAddressList('192.168.20.50', 'suspended_users');
+     * ```
+     */
+    async removeAddressList(address, listName, options) {
+        const result = await this.getAddressLists({ "?address": address, "?list": listName }, options);
+        if (result.length > 0 && result[0]['.id']) {
+            return this.client.write('/ip/firewall/address-list/remove', {
+                ".id": result[0]['.id']
+            }, options);
+        }
+        throw new Error(`IP '${address}' not found in list '${listName}'.`);
+    }
+    // ==========================================
+    // NAT (Network Address Translation)
+    // ==========================================
+    /**
+     * **Retrieve: NAT Rules (PRINT)**
+     *
+     * Sends an `/ip/firewall/nat/print` command to list translation rules.
+     *
+     * @param filter Optional dictionary to filter results.
+     * @param options Advanced write options.
+     * @returns A promise resolving to an array of NAT rules.
+     *
+     * @example
+     * ```typescript
+     * // 1. Retrieve all Port Forwarding (dstnat) rules
+     * const portForwards = await mk.firewall.getNatRules({ "?chain": "dstnat" });
+     * ```
+     */
+    async getNatRules(filter, options) {
+        return this.client.write('/ip/firewall/nat/print', filter || {}, options);
+    }
+    /**
+     * **Resource Creation: NAT Rule (ADD)**
+     *
+     * Sends an `/ip/firewall/nat/add` command to create routing translations.
+     *
+     * **Feature: Internet Access & Port Forwarding**
+     * Core functionality for giving clients internet access (masquerade) or
+     * opening ports for security cameras and servers (dst-nat).
+     *
+     * @param chain Usually 'srcnat' (for internet access) or 'dstnat' (for port forwarding).
+     * @param action The action to perform (e.g., 'masquerade', 'dst-nat', 'accept').
+     * @param additionalParams Dictionary defining the traffic match conditions and target.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // 1. Provide Internet Access (Masquerade) to a specific subnet
+     * await mk.firewall.addNatRule('srcnat', 'masquerade', {
+     * "src-address": "192.168.20.0/24",
+     * "out-interface": "ether1-WAN",
+     * comment: "Main LAN Internet Access"
+     * });
+     * * // 2. Port Forwarding: Open port 8080 to an internal camera server
+     * await mk.firewall.addNatRule('dstnat', 'dst-nat', {
+     * protocol: 'tcp',
+     * "dst-port": "8080",
+     * "in-interface": "ether1-WAN",
+     * "to-addresses": "192.168.20.100",
+     * "to-ports": "80",
+     * comment: "Camera Server Forwarding"
+     * });
+     * ```
+     */
+    async addNatRule(chain, action, additionalParams, options) {
+        return this.client.write('/ip/firewall/nat/add', {
+            chain,
+            action,
+            ...additionalParams
+        }, options);
+    }
+    /**
+     * **Execution Terminator: Delete NAT Rule (REMOVE)**
+     *
+     * Sends an `/ip/firewall/nat/remove` command.
+     *
+     * @param comment The exact comment of the rule to delete (safest way to target dynamically).
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // 1. Remove a specific port forwarding rule by its comment
+     * await mk.firewall.removeNatRuleByComment('Camera Server Forwarding');
+     * ```
+     */
+    async removeNatRuleByComment(comment, options) {
+        const result = await this.getNatRules({ "?comment": comment }, options);
+        if (result.length > 0 && result[0]['.id']) {
+            return this.client.write('/ip/firewall/nat/remove', {
+                ".id": result[0]['.id']
+            }, options);
+        }
+        throw new Error(`NAT rule with comment '${comment}' not found.`);
+    }
+    // ==========================================
+    // FILTER RULES (Security & Traffic Control)
+    // ==========================================
+    /**
+     * **Retrieve: Filter Rules (PRINT)**
+     *
+     * Sends an `/ip/firewall/filter/print` command to list security rules.
+     *
+     * @param filter Optional dictionary to filter results.
+     * @param options Advanced write options.
+     * @returns A promise resolving to an array of filter rules.
+     *
+     * @example
+     * ```typescript
+     * // 1. Check for any rules dropping traffic in the forward chain
+     * const dropRules = await mk.firewall.getFilterRules({ "?action": "drop", "?chain": "forward" });
+     * ```
+     */
+    async getFilterRules(filter, options) {
+        return this.client.write('/ip/firewall/filter/print', filter || {}, options);
+    }
+    /**
+     * **Resource Creation: Filter Rule (ADD)**
+     *
+     * Sends an `/ip/firewall/filter/add` command to control traffic flow.
+     *
+     * **Feature: Automated Network Security**
+     * Use this to programmatically drop traffic from suspended users, block external
+     * DNS queries, or secure the router's management ports.
+     *
+     * @param chain 'input' (to router), 'forward' (through router), or 'output' (from router).
+     * @param action The action to take ('accept', 'drop', 'reject', etc.).
+     * @param additionalParams Dictionary defining the match conditions.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // 1. Block Internet access for suspended users (Forward Chain)
+     * await mk.firewall.addFilterRule('forward', 'drop', {
+     * "src-address-list": "suspended_users",
+     * comment: "Block Internet for suspended clients"
+     * });
+     * * // 2. Protect the router: Drop external DNS requests (Input Chain)
+     * await mk.firewall.addFilterRule('input', 'drop', {
+     * protocol: 'udp',
+     * "dst-port": "53",
+     * "in-interface": "ether1-WAN",
+     * comment: "Drop external DNS"
+     * });
+     * ```
+     */
+    async addFilterRule(chain, action, additionalParams, options) {
+        return this.client.write('/ip/firewall/filter/add', {
+            chain,
+            action,
+            ...additionalParams
+        }, options);
+    }
+    /**
+     * **State Modification: Enable/Disable Filter Rule (SET)**
+     *
+     * Sends an `/ip/firewall/filter/set` command to toggle a rule without deleting it.
+     *
+     * @param comment The exact comment of the rule to toggle.
+     * @param disable Boolean true to disable, false to enable.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // 1. Temporarily disable the rule that blocks suspended clients
+     * await mk.firewall.toggleFilterRuleByComment('Block Internet for suspended clients', true);
+     * ```
+     */
+    async toggleFilterRuleByComment(comment, disable, options) {
+        const result = await this.getFilterRules({ "?comment": comment }, options);
+        if (result.length > 0 && result[0]['.id']) {
+            return this.client.write('/ip/firewall/filter/set', {
+                ".id": result[0]['.id'],
+                disabled: disable ? 'yes' : 'no'
+            }, options);
+        }
+        throw new Error(`Filter rule with comment '${comment}' not found.`);
+    }
+}
+exports.FirewallWrapper = FirewallWrapper;
+//# sourceMappingURL=FirewallWrapper.js.map

package/dist/features/FirewallWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FirewallWrapper.js","sourceRoot":"","sources":["../../src/features/FirewallWrapper.ts"],"names":[],"mappings":";;;AAEA,MAAa,eAAe;IAGxB,YAAY,MAAsB;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,6CAA6C;IAC7C,8CAA8C;IAC9C,6CAA6C;IAE7C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,eAAe,CAAC,MAA+B,EAAE,OAAuB;QAC1E,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iCAAiC,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,cAAc,CAChB,OAAe,EACf,QAAgB,EAChB,gBAA4D,EAC5D,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE;YACtD,OAAO;YACP,IAAI,EAAE,QAAQ;YACd,GAAG,gBAAgB;SACtB,EAAE,OAAO,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,iBAAiB,CAAC,OAAe,EAAE,QAAgB,EAAE,OAAuB;QAC9E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;QAE/F,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kCAAkC,EAAE;gBACzD,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;aAC1B,EAAE,OAAO,CAAC,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,OAAO,OAAO,wBAAwB,QAAQ,IAAI,CAAC,CAAC;IACxE,CAAC;IAED,6CAA6C;IAC7C,oCAAoC;IACpC,6CAA6C;IAE7C;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,WAAW,CAAC,MAA+B,EAAE,OAAuB;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,wBAAwB,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,UAAU,CACZ,KAA0B,EAC1B,MAAc,EACd,gBAA2D,EAC3D,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE;YAC7C,KAAK;YACL,MAAM;YACN,GAAG,gBAAgB;SACtB,EAAE,OAAO,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,sBAAsB,CAAC,OAAe,EAAE,OAAuB;QACjE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;QAExE,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE;gBAChD,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;aAC1B,EAAE,OAAO,CAAC,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,0BAA0B,OAAO,cAAc,CAAC,CAAC;IACrE,CAAC;IAED,6CAA6C;IAC7C,4CAA4C;IAC5C,6CAA6C;IAE7C;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,cAAc,CAAC,MAA+B,EAAE,OAAuB;QACzE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,KAAK,CAAC,aAAa,CACf,KAAqC,EACrC,MAAc,EACd,gBAA2D,EAC3D,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE;YAChD,KAAK;YACL,MAAM;YACN,GAAG,gBAAgB;SACtB,EAAE,OAAO,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,yBAAyB,CAAC,OAAe,EAAE,OAAgB,EAAE,OAAuB;QACtF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,EAAE,UAAU,EAAE,OAAO,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,yBAAyB,EAAE;gBAChD,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;gBACvB,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;aACnC,EAAE,OAAO,CAAC,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,6BAA6B,OAAO,cAAc,CAAC,CAAC;IACxE,CAAC;CACJ;AA1SD,0CA0SC"}

package/dist/features/IpWrapper.d.ts

@@ -0,0 +1,140 @@
+import { MikrotikClient, IWriteOptions } from "../client/MikrotikClient";
+export declare class IpWrapper {
+    private client;
+    constructor(client: MikrotikClient);
+    /**
+     * **Retrieve: DHCP Leases (PRINT)**
+     *
+     * Sends a `/ip/dhcp-server/lease/print` command to get active or static leases.
+     *
+     * **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., `{"?mac-address": "00:11:22:33:44:55"}`).
+     * @param options Advanced write options (idempotency, forced protocol).
+     * @returns A promise resolving to an array of DHCP lease objects.
+     *
+     * @example
+     * ```typescript
+     * // Find the IP address currently assigned to a specific MAC
+     * const leases = await mk.ip.getDhcpLeases({ "?mac-address": "00:11:22:33:44:55" });
+     * if (leases.length > 0) {
+     * console.log(`Assigned IP: ${leases[0].address}`);
+     * }
+     * ```
+     */
+    getDhcpLeases(filter?: Record<string, string>, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Resource Creation: Static Lease (ADD)**
+     *
+     * Sends an `/ip/dhcp-server/lease/add` command to bind an IP to a MAC address.
+     *
+     * **Feature: Permanent IP Binding**
+     * Essential for IPoE networks where clients require a fixed IP address
+     * based on their hardware address without using PPPoE.
+     *
+     * @param macAddress The hardware MAC address of the client's router/device.
+     * @param ipAddress The static IP address to assign.
+     * @param server The name of the DHCP server instance (e.g., 'dhcp_lan').
+     * @param additionalParams Optional dictionary for extra parameters (comment, client-id).
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Assign a static IP to a new customer's router
+     * await mk.ip.addStaticLease(
+     * '00:11:22:33:44:55',
+     * '192.168.20.50',
+     * 'dhcp_lan',
+     * { comment: 'Customer: Alice Smith - Plan Basic' }
+     * );
+     * ```
+     */
+    addStaticLease(macAddress: string, ipAddress: string, server: string, additionalParams?: Record<string, string | boolean | number>, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Execution Terminator: Delete Lease (REMOVE)**
+     *
+     * Sends an `/ip/dhcp-server/lease/remove` command to delete a lease.
+     *
+     * **Feature: Safe Deletion**
+     * It automatically searches for the dynamic internal ID (`.id`) using the provided IP
+     * before attempting to remove it.
+     *
+     * @param ipAddress The exact IP address of the lease to remove.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Remove a customer's IP binding after service cancellation
+     * try {
+     * await mk.ip.removeDhcpLease('192.168.20.50');
+     * console.log('Lease removed successfully');
+     * } catch (error) {
+     * console.error(error.message);
+     * }
+     * ```
+     */
+    removeDhcpLease(ipAddress: string, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Retrieve: ARP Table (PRINT)**
+     *
+     * Sends an `/ip/arp/print` command to list current ARP entries.
+     *
+     * @param filter Optional dictionary to filter results (e.g., searching by interface or IP).
+     * @param options Advanced write options.
+     * @returns A promise resolving to an array of ARP entries.
+     *
+     * @example
+     * ```typescript
+     * // Check if a specific IP is reachable at layer 2
+     * const arpEntries = await mk.ip.getArpEntries({ "?address": "192.168.20.50" });
+     * const isConnected = arpEntries.length > 0;
+     * ```
+     */
+    getArpEntries(filter?: Record<string, string>, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Resource Creation: Static ARP (ADD)**
+     *
+     * Sends an `/ip/arp/add` command to create a static layer 2 binding.
+     *
+     * **Feature: Layer 2 Security**
+     * Highly recommended for WISP security to prevent IP spoofing when
+     * the router interface is set to `reply-only`.
+     *
+     * @param macAddress The hardware MAC address of the client.
+     * @param ipAddress The exact IP address assigned to the client.
+     * @param interfaceName The physical or logical interface facing the client.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Secure a static IP customer by binding their MAC to the interface
+     * await mk.ip.addStaticArp(
+     * '00:11:22:33:44:55',
+     * '192.168.20.50',
+     * 'ether3_Clients'
+     * );
+     * ```
+     */
+    addStaticArp(macAddress: string, ipAddress: string, interfaceName: string, options?: IWriteOptions): Promise<any[]>;
+    /**
+     * **Execution Terminator: Delete ARP Entry (REMOVE)**
+     *
+     * Sends an `/ip/arp/remove` command to delete a static or dynamic ARP entry.
+     *
+     * @param ipAddress The IP address of the ARP entry to delete.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Clean up the ARP table when a client is permanently disconnected
+     * await mk.ip.removeArpEntry('192.168.20.50');
+     * ```
+     */
+    removeArpEntry(ipAddress: string, options?: IWriteOptions): Promise<any[]>;
+}

package/dist/features/IpWrapper.js

@@ -0,0 +1,184 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IpWrapper = void 0;
+class IpWrapper {
+    constructor(client) {
+        this.client = client;
+    }
+    // ==========================================
+    // DHCP LEASES (Static IP Assignment)
+    // ==========================================
+    /**
+     * **Retrieve: DHCP Leases (PRINT)**
+     *
+     * Sends a `/ip/dhcp-server/lease/print` command to get active or static leases.
+     *
+     * **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., `{"?mac-address": "00:11:22:33:44:55"}`).
+     * @param options Advanced write options (idempotency, forced protocol).
+     * @returns A promise resolving to an array of DHCP lease objects.
+     *
+     * @example
+     * ```typescript
+     * // Find the IP address currently assigned to a specific MAC
+     * const leases = await mk.ip.getDhcpLeases({ "?mac-address": "00:11:22:33:44:55" });
+     * if (leases.length > 0) {
+     * console.log(`Assigned IP: ${leases[0].address}`);
+     * }
+     * ```
+     */
+    async getDhcpLeases(filter, options) {
+        return this.client.write('/ip/dhcp-server/lease/print', filter || {}, options);
+    }
+    /**
+     * **Resource Creation: Static Lease (ADD)**
+     *
+     * Sends an `/ip/dhcp-server/lease/add` command to bind an IP to a MAC address.
+     *
+     * **Feature: Permanent IP Binding**
+     * Essential for IPoE networks where clients require a fixed IP address
+     * based on their hardware address without using PPPoE.
+     *
+     * @param macAddress The hardware MAC address of the client's router/device.
+     * @param ipAddress The static IP address to assign.
+     * @param server The name of the DHCP server instance (e.g., 'dhcp_lan').
+     * @param additionalParams Optional dictionary for extra parameters (comment, client-id).
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Assign a static IP to a new customer's router
+     * await mk.ip.addStaticLease(
+     * '00:11:22:33:44:55',
+     * '192.168.20.50',
+     * 'dhcp_lan',
+     * { comment: 'Customer: Alice Smith - Plan Basic' }
+     * );
+     * ```
+     */
+    async addStaticLease(macAddress, ipAddress, server, additionalParams, options) {
+        return this.client.write('/ip/dhcp-server/lease/add', {
+            "mac-address": macAddress,
+            address: ipAddress,
+            server: server,
+            ...additionalParams
+        }, options);
+    }
+    /**
+     * **Execution Terminator: Delete Lease (REMOVE)**
+     *
+     * Sends an `/ip/dhcp-server/lease/remove` command to delete a lease.
+     *
+     * **Feature: Safe Deletion**
+     * It automatically searches for the dynamic internal ID (`.id`) using the provided IP
+     * before attempting to remove it.
+     *
+     * @param ipAddress The exact IP address of the lease to remove.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Remove a customer's IP binding after service cancellation
+     * try {
+     * await mk.ip.removeDhcpLease('192.168.20.50');
+     * console.log('Lease removed successfully');
+     * } catch (error) {
+     * console.error(error.message);
+     * }
+     * ```
+     */
+    async removeDhcpLease(ipAddress, options) {
+        const result = await this.getDhcpLeases({ "?address": ipAddress }, options);
+        if (result.length > 0 && result[0]['.id']) {
+            return this.client.write('/ip/dhcp-server/lease/remove', {
+                ".id": result[0]['.id']
+            }, options);
+        }
+        throw new Error(`DHCP Lease for IP '${ipAddress}' not found.`);
+    }
+    // ==========================================
+    // ARP (Address Resolution Protocol / Security)
+    // ==========================================
+    /**
+     * **Retrieve: ARP Table (PRINT)**
+     *
+     * Sends an `/ip/arp/print` command to list current ARP entries.
+     *
+     * @param filter Optional dictionary to filter results (e.g., searching by interface or IP).
+     * @param options Advanced write options.
+     * @returns A promise resolving to an array of ARP entries.
+     *
+     * @example
+     * ```typescript
+     * // Check if a specific IP is reachable at layer 2
+     * const arpEntries = await mk.ip.getArpEntries({ "?address": "192.168.20.50" });
+     * const isConnected = arpEntries.length > 0;
+     * ```
+     */
+    async getArpEntries(filter, options) {
+        return this.client.write('/ip/arp/print', filter || {}, options);
+    }
+    /**
+     * **Resource Creation: Static ARP (ADD)**
+     *
+     * Sends an `/ip/arp/add` command to create a static layer 2 binding.
+     *
+     * **Feature: Layer 2 Security**
+     * Highly recommended for WISP security to prevent IP spoofing when
+     * the router interface is set to `reply-only`.
+     *
+     * @param macAddress The hardware MAC address of the client.
+     * @param ipAddress The exact IP address assigned to the client.
+     * @param interfaceName The physical or logical interface facing the client.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Secure a static IP customer by binding their MAC to the interface
+     * await mk.ip.addStaticArp(
+     * '00:11:22:33:44:55',
+     * '192.168.20.50',
+     * 'ether3_Clients'
+     * );
+     * ```
+     */
+    async addStaticArp(macAddress, ipAddress, interfaceName, options) {
+        return this.client.write('/ip/arp/add', {
+            "mac-address": macAddress,
+            address: ipAddress,
+            interface: interfaceName
+        }, options);
+    }
+    /**
+     * **Execution Terminator: Delete ARP Entry (REMOVE)**
+     *
+     * Sends an `/ip/arp/remove` command to delete a static or dynamic ARP entry.
+     *
+     * @param ipAddress The IP address of the ARP entry to delete.
+     * @param options Advanced write options.
+     * @returns A promise resolving to the API response.
+     *
+     * @example
+     * ```typescript
+     * // Clean up the ARP table when a client is permanently disconnected
+     * await mk.ip.removeArpEntry('192.168.20.50');
+     * ```
+     */
+    async removeArpEntry(ipAddress, options) {
+        const result = await this.getArpEntries({ "?address": ipAddress }, options);
+        if (result.length > 0 && result[0]['.id']) {
+            return this.client.write('/ip/arp/remove', {
+                ".id": result[0]['.id']
+            }, options);
+        }
+        throw new Error(`ARP entry for IP '${ipAddress}' not found.`);
+    }
+}
+exports.IpWrapper = IpWrapper;
+//# sourceMappingURL=IpWrapper.js.map

package/dist/features/IpWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IpWrapper.js","sourceRoot":"","sources":["../../src/features/IpWrapper.ts"],"names":[],"mappings":";;;AAEA,MAAa,SAAS;IAGlB,YAAY,MAAsB;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,6CAA6C;IAC7C,qCAAqC;IACrC,6CAA6C;IAE7C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,aAAa,CAAC,MAA+B,EAAE,OAAuB;QACxE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,cAAc,CAChB,UAAkB,EAClB,SAAiB,EACjB,MAAc,EACd,gBAA4D,EAC5D,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,EAAE;YAClD,aAAa,EAAE,UAAU;YACzB,OAAO,EAAE,SAAS;YAClB,MAAM,EAAE,MAAM;YACd,GAAG,gBAAgB;SACtB,EAAE,OAAO,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,eAAe,CAAC,SAAiB,EAAE,OAAuB;QAC5D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;QAE5E,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE;gBACrD,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;aAC1B,EAAE,OAAO,CAAC,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,sBAAsB,SAAS,cAAc,CAAC,CAAC;IACnE,CAAC;IAED,6CAA6C;IAC7C,+CAA+C;IAC/C,6CAA6C;IAE7C;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,aAAa,CAAC,MAA+B,EAAE,OAAuB;QACxE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,YAAY,CACd,UAAkB,EAClB,SAAiB,EACjB,aAAqB,EACrB,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE;YACpC,aAAa,EAAE,UAAU;YACzB,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,aAAa;SAC3B,EAAE,OAAO,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,cAAc,CAAC,SAAiB,EAAE,OAAuB;QAC3D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;QAE5E,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE;gBACvC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;aAC1B,EAAE,OAAO,CAAC,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,qBAAqB,SAAS,cAAc,CAAC,CAAC;IAClE,CAAC;CACJ;AAzMD,8BAyMC"}