iproutejs 2.3.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2024 Diosney Sarmiento
+Copyright (c) 2026 jakguel
+
+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.

package/README.md

@@ -0,0 +1,245 @@
+# iproutejs
+
+Show and manipulate network devices, addresses, routing, policy routing, tunnels, IP forwarding, address labels and other `iproute` objects.
+
+Wrapper around native **iproute** suite to allow its functionality to be used in Node.js space.
+
+[![donate](https://shields.io/badge/ko--fi-donate-ff5f5f?logo=ko-fi&style=for-the-badgeKo-fi)](https://ko-fi.com/diosney)
+[![docs](https://github.com/jakguel/iproutejs/actions/workflows/docs.yml/badge.svg?branch=master)](https://github.com/jakguel/iproutejs/actions/workflows/docs.yml)
+[![tests](https://github.com/jakguel/iproutejs/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/jakguel/iproutejs/actions/workflows/tests.yml)
+[![npm](https://img.shields.io/npm/v/iproute)](https://www.npmjs.com/package/iproute)
+
+## Installation
+
+	$ npm install iproutejs --save
+
+## Supported Functionality
+
+| Command                                                              | Description                                             | Operations                                                                             |
+|----------------------------------------------------------------------|---------------------------------------------------------|----------------------------------------------------------------------------------------|
+| [batch](https://jakguel.github.io/iproutejs/modules/batch.html)   | Batch mode.                                      | `fromFile`, `fromStdin`                                                                |
+| [link](https://jakguel.github.io/iproutejs/modules/link.html)     | Network devices configuration.                          | `add`, `del`, `show`, `set`, `change`                                                  |
+| [address](https://jakguel.github.io/iproutejs/modules/address.html) | Protocol address management.                            | `add`, `change`, `replace`, `del`, `flush`, `save`, `restore`, `showdump`, `show`      |
+| [route](https://jakguel.github.io/iproutejs/modules/route.html)   | Routing table management.                               | `show`, `flush`, `save`, `restore`, `get`, `add`, `del`, `change`, `append`, `replace` |
+| [rule](https://jakguel.github.io/iproutejs/modules/rule.html)     | Routing policy database (RPDB) management.              | `add`, `del`, `save`, `restore`, `flush`, `show`, `list`                               |
+| [monitor](https://jakguel.github.io/iproutejs/modules/monitor.html) | State monitoring.                                       | `on`, `close`                                                                          |
+| [addrlabel](https://jakguel.github.io/iproutejs/modules/addrlabel.html) | Protocol address label management.                      | `add`, `del`, `list`, `flush`                                                          |
+| [neighbour](https://jakguel.github.io/iproutejs/modules/neighbour.html) | Neighbour/ARP tables management.                        | `add`, `del`, `change`, `replace`, `flush`, `show`, `get`                               |
+| [ntable](https://jakguel.github.io/iproutejs/modules/ntable.html) | Neighbour table configuration.                          | `change`, `show`                                                                       |
+| [tunnel](https://jakguel.github.io/iproutejs/modules/tunnel.html) | Tunnel configuration.                                   | `add`, `change`, `del`, `show`, `prl`, `6rd`                                           |
+| [tuntap](https://jakguel.github.io/iproutejs/modules/tuntap.html) | TunTap tunnel configuration.                            | `add`, `del`, `show`, `list`, `lst`                                                    |
+| [maddress](https://jakguel.github.io/iproutejs/modules/maddress.html) | Multicast addresses management.                         | `add`, `del`, `show`                                                                   |
+| [mroute](https://jakguel.github.io/iproutejs/modules/mroute.html) | Multicast routing cache management.                     | `show`                                                                                 |
+| [utils](https://jakguel.github.io/iproutejs/modules/utils.html)   | Custom utility library that complements `iproute` suite. | -                                                                                      |
+| [utils.ipForwarding](https://jakguel.github.io/iproutejs/modules/utils.ipForwarding.html) | Manipulates IP forwarding.                              | `enable`, `disable`, `status`, `v{4\|6}.enable`, `v{4\|6}.disable`, `v{4\|6}.status`   |
+| [utils.routingTables](https://jakguel.github.io/iproutejs/modules/utils.routingTables.html) | Manipulates routing tables.                             | `show`, `add`, `del`, `clear`                                                          |
+
+## Docs
+
+The documentation is divided across several files:
+
+| Link                                                                           | Description                                                                              |
+|--------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
+| [Public API site](https://jakguel.github.io/iproutejs)                      | Provides a comprehensive index of the library interfaces, constants, enums, and classes. |
+| [README.md](https://github.com/jakguel/iproutejs/blob/master/README.md)     | This document.                                                                                  |
+| [EXAMPLES.md](https://github.com/jakguel/iproutejs/blob/master/EXAMPLES.md) | Code samples showcasing how to use the library.                                          |
+| [TODO.md](https://github.com/jakguel/iproutejs/blob/master/TODO.md)         | A checklist of several items to add or improve upon.                                     |
+
+## Motivation
+
+Given the current Node.js version (`v20.5.1`), the network-related functionality provided by the built-in modules is 
+somewhat limited. These modules mainly offer read-only information through the `os.networkInterfaces()` method. This 
+design ensures consistency across the various operating systems that Node.js supports. However, it restricts us from 
+performing common networking operations, such as adding, editing, or deleting links, addresses, or routes.
+
+This module bridges this gap for the Unix/Linux platform by introducing methods that wrap the **iproute** user-space suite.
+
+With this module, you can:
+
+- Interact seamlessly with **iproute** commands, without the need to directly execute commands or verify option validations.
+- Access numerous utilities to modify routing tables and manage forwarding capabilities.
+- Eliminate the redundancy of boilerplate code, as the module handles these shared operations across all commands for you.
+- Use the provided interfaces and types to help you to discover the IP command options.
+- Use the Typedoc documentation to navigate between options, its descriptions and its types.
+
+## Requirements
+
+### Having **iproute** available in the system
+
+The primary requirement is the presence of the  **iproute** utility on the system.
+
+On Debian-based OSes, if it's not already installed, you can do it by issuing:
+
+	sudo apt-get install iproute     # Or `iproute2`
+
+Regarding the **iproute** version, the `-json` option is used for display operations and was introduced in `v4.10.0`.
+<br>
+Ensure that your system has at least this version installed.
+
+**Note:** JSON support for the `ip neighbour get` command was added at a later version, if you need this specific 
+command check the output in case it is not supported in your version. 
+
+### Permission Level
+
+Another requirement concerns permission levels. 
+For the successful execution of write methods such as `add()`, `set()`, and `delete()` the application using the 
+module must have the appropriate `sudo` privileges. 
+
+One approach to achieve this is by adding a custom user to the system:
+
+`sudo adduser --system --no-create-home iproute` 
+
+then add its permissions in the `/etc/sudoers` file:
+
+`iproute ALL=NOPASSWD: /sbin/ip, /sbin/sysctl`
+
+You can determine the command paths by issuing `which ip` and `which sysctl`.
+
+> **Note:** Modifying the `/etc/sudoers` file directly can be dangerous. It's generally recommended to use the `visudo`
+> command when editing this file to prevent syntax errors, which could lock you out of `sudo` capabilities.
+
+And lastly execute the commands with the `sudo: true` global option:
+
+	link.show({}, {
+      sudo: true
+    });
+
+    ipForwarding.v4.enable({
+      sudo: true
+    });
+
+## Usage
+
+As a general guideline, the module identifiers and options match those provided by **iproute**. This means you can easily use 
+the module with a basic understanding of **iproute**.
+
+For autocompletion, you can rely on the type definitions supplied within the library or refer to the interface documentation
+at the [API documentation](https://jakguel.github.io/iproutejs/modules.html).
+
+### How to Import
+
+If you are using Javascript, you can import using the regular CommonJS `require` as follows:
+
+    const { link } = require('iproutejs').default;
+    const { link } = require('iproutejs');
+    const iproute  = require('iproutejs');
+
+If you are using Typescript, you can use the aforementioned `require` calls, or just Ecmascript modules import:
+
+    import { link } from 'iproutejs';
+    import iproute, { link } from 'iproutejs';
+    import * as iproute from 'iproutejs';
+
+### How to Use
+
+All methods return Promises, so you can use them directly with `.then().catch()` or you can use `async/await`.
+Both of these calls are valid:
+
+    const { utils } = require('iproutejs');
+    
+    // Using Promises.
+    utils
+      .ipForwarding
+      .enable({ sudo: true })
+      .then(() => {
+        // Do something;
+      })
+      .catch(() => {
+        // Do something;
+      });
+
+    // Using async/await.
+    await utils.ipForwarding.enable({ sudo: true });
+
+### Some Important Notes
+
+- All `show` operations use the native `iproute` `-json` flag, which prevents many errors if parsed manually but also
+  means the output interfaces are different that the ones provided by this library `1.x.x` version.
+
+- In `2.x.x` you must have to call `ip route flush table cache` by yourself after modifying the **rules** or the **routing tables**.
+  This is by design to match the native `iproute` behavior, so one can do several operations before making the changes active. 
+
+  You can do it by using the following code:
+
+      import { route } from 'iproutejs';
+
+      await route.flush({
+        table: RouteRoutingTables.Cache   // 'cache'
+      });
+
+- Need help to complete the interfaces:
+  - [RuleInfo](https://jakguel.github.io/iproutejs/interfaces/RuleInfo.html)
+  - [RouteInfo](https://jakguel.github.io/iproutejs/interfaces/RouteInfo.html)
+  - [LinkInfo](https://jakguel.github.io/iproutejs/interfaces/LinkInfo.html)
+  - [LinkWithAddressInfo](https://jakguel.github.io/iproutejs/interfaces/LinkWithAddressInfo.html)
+  - [NeighbourInfo](https://jakguel.github.io/iproutejs/interfaces/NeighbourInfo.html)
+  - [NtableInfo](https://jakguel.github.io/iproutejs/interfaces/NtableInfo.html)
+  - [TunnelInfo](https://jakguel.github.io/iproutejs/interfaces/TunnelInfo.html)
+  - [TunTapTunnelInfo](https://jakguel.github.io/iproutejs/interfaces/TunTapTunnelInfo.html)
+  - [MaddressInfo](https://jakguel.github.io/iproutejs/interfaces/MaddressInfo.html)
+  - [MrouteInfo](https://jakguel.github.io/iproutejs/interfaces/MrouteInfo.html)
+ 
+A **PR** is more than welcome.
+
+## Issues
+
+The source code can be accessed on [GitHub](https://github.com/jakguel/iproutejs).
+<br>
+If you encounter any bugs or need a new feature, please report them on the
+[issue tracker](https://github.com/jakguel/iproutejs/issues).
+
+## Contributing
+
+If you want to contribute just follow the project organization and code style and submit a **PR**.
+<br>
+If you want to be an official maintainer or contributor just say so, this library is bigger that it seems and there are a
+lot of features to add or to improve.
+
+For potential features to contribute to, please refer to the [TODO.md](https://github.com/jakguel/iproutejs/blob/master/TODO.md) in the project root directory.
+This can be specially helpful if you're unsure of what to contribute or if the [issues](https://github.com/jakguel/iproutejs/issues) board is empty.
+
+## Tests
+
+### tldr;
+
+You can run `npm test`, which is safe to execute as explained below, since it doesn't really execute any commands.
+
+### Detailed Explanation
+
+Since manipulating the interfaces, routes and routing tables can let your box without access to the Internet, to ease
+the library development the tests are divided in three npm scripts:
+
+- `test:safe`, which are safe to execute even in your regular computer and don't really run any `iproute` commands,
+- `test:exec`, which **do** execute real commands and can leave the box in an unexpected state if they fail, in which case a simple reboot
+          should be enough to restore the default interfaces, addresses and route information.
+- `test:all`, which as implies executes both the `test:safe` and the `test:exec` tests.
+- `test:github-actions`, which are all except `exec/utils` since Github Actions doesn't allow to modify `rt_tables` nor
+   the `sysctl` variables (if you find a way, a **PR** is more than welcome!).
+
+For that reason, the default set of tests that are called by `npm test` are the `safe` ones.
+
+If you want to execute all the tests, you can set up a **virtual machine** and execute `npm run test:all` there.
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2014-2024 Diosney Sarmiento
+
+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.

package/lib/commands/address/add.interfaces.d.ts

@@ -0,0 +1,94 @@
+import { AddressScopes } from '../address.constants';
+/**
+ * Address add options.
+ * @category Interfaces
+ */
+export interface AddressAddOptions {
+    /**
+     *  The address of the interface. The format of the address depends on the protocol.
+     *
+     *  It is a dotted quad for IP and a sequence of hexadecimal halfwords separated by colons for IPv6.
+     *  The ADDRESS may be followed by a slash and a decimal number which encodes the network prefix length.
+     */
+    local: string;
+    /**
+     * The address of the remote endpoint for pointopoint interfaces.
+     *
+     * Again, the ADDRESS may be followed by a slash and a decimal number, encoding the network prefix length.
+     * If a peer address is specified, the local address cannot have a prefix length.
+     * The network prefix is associated with the peer rather than with the local address.
+     */
+    peer?: string;
+    /**
+     * The broadcast address on the interface.
+     *
+     * It is possible to use the special symbols '+' and '-' instead of the broadcast address.
+     * In this case, the broadcast address is derived by setting/resetting the host bits of the interface prefix.
+     */
+    broadcast?: '+' | '-' | string;
+    /** TODO: Missing from manpage. */
+    anycast?: string;
+    /**
+     * Each address may be tagged with a label string.
+     * In order to preserve compatibility with Linux-2.0 net aliases, this string must coincide with the
+     * name of the device or must be prefixed with the device name followed by colon.
+     * The maximum allowed total length of label is 15 characters.
+     */
+    label?: string;
+    /**
+     * The scope of the area where this address is valid.
+     * The available scopes are listed in file `/etc/iproute2/rt_scopes`.
+     */
+    scope?: AddressScopes | number;
+    /** The name of the device to add the address to. */
+    dev: string;
+    /**
+     * The valid lifetime of this address; see section 5.5.4 of RFC 4862.
+     * When it expires, the address is removed by the kernel.
+     * Defaults to `forever`.
+     */
+    valid_lft?: 'forever' | number;
+    /**
+     * The preferred lifetime of this address; see section 5.5.4 of RFC 4862.
+     * When it expires, the address is no longer used for new outgoing connections.
+     * Defaults to `forever`.
+     */
+    preferred_lft?: 'forever' | number;
+    /** (IPv6 only) designates this address the "home address" as defined in RFC 6275. */
+    home?: true;
+    /**
+     * (IPv6 only) make the kernel manage temporary addresses created from this one as template on behalf of
+     * Privacy Extensions (RFC3041).
+     *
+     * For this to become active, the `use_tempaddr` sysctl setting has to be set to a value greater than zero.
+     * The given address needs to have a prefix length of 64.
+     *
+     * This flag allows to use privacy extensions in a manually configured network, just like if stateless
+     * auto-configuration was active.
+     */
+    mngtmpaddr?: true;
+    /** (IPv6 only) do not perform Duplicate Address Detection (RFC 4862) when adding this address. */
+    nodad?: true;
+    /** (IPv6 only) When performing Duplicate Address Detection, use the RFC 4429 optimistic variant. */
+    optimistic?: true;
+    /**
+     * Do not automatically create a route for the network prefix of the added address, and don't search for one
+     * to delete when removing the address.
+     *
+     * Changing an address to add this flag will remove the automatically added prefix route, changing it
+     * to remove this flag will create the prefix route automatically.
+     */
+    noprefixroute?: true;
+    /**
+     * Joining multicast groups on Ethernet level via ip maddr command does not work if connected to an Ethernet
+     * switch that does IGMP snooping since the switch would not replicate multicast packets on ports that did
+     * not have IGMP reports for the multicast addresses.
+     *
+     * Linux VXLAN interfaces created via ip link add vxlan have the group option that enables them to do the required
+     * join.
+     *
+     * Using the autojoin flag when adding a multicast address enables similar functionality for Openvswitch VXLAN
+     * interfaces as well as other tunneling mechanisms that need to receive multicast traffic.
+     */
+    autojoin?: true;
+}

package/lib/commands/address/add.interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=add.interfaces.js.map

package/lib/commands/address/add.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add.interfaces.js","sourceRoot":"","sources":["../../../src/commands/address/add.interfaces.ts"],"names":[],"mappings":""}

package/lib/commands/address/add.schema.d.ts

@@ -0,0 +1,3 @@
+import { JSONSchemaType } from 'ajv';
+import { AddressAddOptions } from './add.interfaces';
+export declare const AddressAddSchema: JSONSchemaType<AddressAddOptions>;

package/lib/commands/address/add.schema.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddressAddSchema = void 0;
+const schemas_1 = require("../../common/constants/schemas");
+const address_constants_1 = require("../address.constants");
+exports.AddressAddSchema = {
+    $id: schemas_1.SchemaIds.AddressAdd,
+    type: 'object',
+    required: ['local', 'dev'],
+    properties: {
+        local: {
+            type: 'string',
+            format: 'ip-with-optional-mask'
+        },
+        peer: {
+            type: 'string',
+            format: 'ip-with-optional-mask',
+            nullable: true
+        },
+        broadcast: {
+            type: 'string',
+            format: 'ip-with-optional-mask',
+            nullable: true
+        },
+        anycast: {
+            type: 'string',
+            format: 'ip-with-optional-mask',
+            nullable: true
+        },
+        label: {
+            type: 'string',
+            minLength: 1,
+            maxLength: 15,
+            nullable: true
+        },
+        scope: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    enum: Object.values(address_constants_1.AddressScopes),
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        },
+        dev: {
+            type: 'string',
+            minLength: 1,
+            maxLength: 15
+        },
+        valid_lft: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    enum: ['forever'],
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        },
+        preferred_lft: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    enum: ['forever'],
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        },
+        home: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        mngtmpaddr: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        nodad: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        optimistic: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        noprefixroute: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        autojoin: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        }
+    }
+};
+//# sourceMappingURL=add.schema.js.map

package/lib/commands/address/add.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add.schema.js","sourceRoot":"","sources":["../../../src/commands/address/add.schema.ts"],"names":[],"mappings":";;;AAEA,4DAAmE;AACnE,4DAAyD;AAG5C,QAAA,gBAAgB,GAAsC;IACjE,GAAG,EAAS,mBAAS,CAAC,UAAU;IAChC,IAAI,EAAQ,QAAQ;IACpB,QAAQ,EAAI,CAAC,OAAO,EAAE,KAAK,CAAC;IAC5B,UAAU,EAAE;QACV,KAAK,EAAM;YACT,IAAI,EAAI,QAAQ;YAChB,MAAM,EAAE,uBAAuB;SAChC;QACD,IAAI,EAAO;YACT,IAAI,EAAM,QAAQ;YAClB,MAAM,EAAI,uBAAuB;YACjC,QAAQ,EAAE,IAAI;SACf;QACD,SAAS,EAAE;YACT,IAAI,EAAM,QAAQ;YAClB,MAAM,EAAI,uBAAuB;YACjC,QAAQ,EAAE,IAAI;SACf;QACD,OAAO,EAAI;YACT,IAAI,EAAM,QAAQ;YAClB,MAAM,EAAI,uBAAuB;YACjC,QAAQ,EAAE,IAAI;SACf;QACD,KAAK,EAAM;YACT,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,EAAE;YACb,QAAQ,EAAG,IAAI;SAChB;QACD,KAAK,EAAM;YACT,IAAI,EAAM,CAAE,QAAQ,EAAE,SAAS,CAAE;YACjC,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,iCAAa,CAAoB;oBACzD,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,GAAG,EAAQ;YACT,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,EAAE;SACd;QACD,SAAS,EAAM;YACb,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,IAAI,EAAM,CAAC,SAAS,CAAC;oBACrB,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,aAAa,EAAE;YACb,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,IAAI,EAAM,CAAC,SAAS,CAAC;oBACrB,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,IAAI,EAAW;YACb,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,UAAU,EAAK;YACb,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,KAAK,EAAU;YACb,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,UAAU,EAAK;YACb,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,aAAa,EAAE;YACb,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,QAAQ,EAAO;YACb,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;KACF;CACF,CAAC"}

package/lib/commands/address/delete.interfaces.d.ts

@@ -0,0 +1,56 @@
+import { AddressScopes } from '../address.constants';
+/**
+ * Address delete options.
+ * @category Interfaces
+ */
+export interface AddressDeleteOptions {
+    /**
+     *  The address of the interface. The format of the address depends on the protocol.
+     *
+     *  It is a dotted quad for IP and a sequence of hexadecimal halfwords separated by colons for IPv6.
+     *  The ADDRESS may be followed by a slash and a decimal number which encodes the network prefix length.
+     */
+    local: string;
+    /**
+     * The address of the remote endpoint for pointopoint interfaces.
+     *
+     * Again, the ADDRESS may be followed by a slash and a decimal number, encoding the network prefix length.
+     * If a peer address is specified, the local address cannot have a prefix length.
+     * The network prefix is associated with the peer rather than with the local address.
+     */
+    peer?: string;
+    /**
+     * The broadcast address on the interface.
+     *
+     * It is possible to use the special symbols '+' and '-' instead of the broadcast address.
+     * In this case, the broadcast address is derived by setting/resetting the host bits of the interface prefix.
+     */
+    broadcast?: '+' | '-' | string;
+    /** TODO: Missing from manpage. */
+    anycast?: string;
+    /**
+     * Each address may be tagged with a label string.
+     * In order to preserve compatibility with Linux-2.0 net aliases, this string must coincide with the
+     * name of the device or must be prefixed with the device name followed by colon.
+     * The maximum allowed total length of label is 15 characters.
+     */
+    label?: string;
+    /**
+     * The scope of the area where this address is valid.
+     * The available scopes are listed in file `/etc/iproute2/rt_scopes`.
+     */
+    scope?: AddressScopes | number;
+    /** The name of the device. */
+    dev: string;
+    /**
+     * (IPv6 only) make the kernel manage temporary addresses created from this one as template on behalf of
+     * Privacy Extensions (RFC3041).
+     *
+     * For this to become active, the `use_tempaddr` sysctl setting has to be set to a value greater than zero.
+     * The given address needs to have a prefix length of 64.
+     *
+     * This flag allows to use privacy extensions in a manually configured network, just like if stateless
+     * auto-configuration was active.
+     */
+    mngtmpaddr?: true;
+}

package/lib/commands/address/delete.interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=delete.interfaces.js.map

package/lib/commands/address/delete.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete.interfaces.js","sourceRoot":"","sources":["../../../src/commands/address/delete.interfaces.ts"],"names":[],"mappings":""}

package/lib/commands/address/delete.schema.d.ts

@@ -0,0 +1,3 @@
+import { JSONSchemaType } from 'ajv';
+import { AddressDeleteOptions } from './delete.interfaces';
+export declare const AddressDeleteSchema: JSONSchemaType<AddressDeleteOptions>;

package/lib/commands/address/delete.schema.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddressDeleteSchema = void 0;
+const schemas_1 = require("../../common/constants/schemas");
+const address_constants_1 = require("../address.constants");
+exports.AddressDeleteSchema = {
+    $id: schemas_1.SchemaIds.AddressDelete,
+    type: 'object',
+    required: ['local', 'dev'],
+    properties: {
+        local: {
+            type: 'string',
+            format: 'ip-with-optional-mask'
+        },
+        peer: {
+            type: 'string',
+            format: 'ip-with-optional-mask',
+            nullable: true
+        },
+        broadcast: {
+            type: 'string',
+            format: 'ip-with-optional-mask',
+            nullable: true
+        },
+        anycast: {
+            type: 'string',
+            format: 'ip-with-optional-mask',
+            nullable: true
+        },
+        label: {
+            type: 'string',
+            minLength: 1,
+            maxLength: 15,
+            nullable: true
+        },
+        scope: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    enum: Object.values(address_constants_1.AddressScopes),
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        },
+        dev: {
+            type: 'string',
+            minLength: 1,
+            maxLength: 15
+        },
+        mngtmpaddr: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        }
+    }
+};
+//# sourceMappingURL=delete.schema.js.map

package/lib/commands/address/delete.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete.schema.js","sourceRoot":"","sources":["../../../src/commands/address/delete.schema.ts"],"names":[],"mappings":";;;AAEA,4DAAsE;AAEtE,4DAA4D;AAE/C,QAAA,mBAAmB,GAAyC;IACvE,GAAG,EAAS,mBAAS,CAAC,aAAa;IACnC,IAAI,EAAQ,QAAQ;IACpB,QAAQ,EAAI,CAAE,OAAO,EAAE,KAAK,CAAE;IAC9B,UAAU,EAAE;QACV,KAAK,EAAO;YACV,IAAI,EAAI,QAAQ;YAChB,MAAM,EAAE,uBAAuB;SAChC;QACD,IAAI,EAAQ;YACV,IAAI,EAAM,QAAQ;YAClB,MAAM,EAAI,uBAAuB;YACjC,QAAQ,EAAE,IAAI;SACf;QACD,SAAS,EAAG;YACV,IAAI,EAAM,QAAQ;YAClB,MAAM,EAAI,uBAAuB;YACjC,QAAQ,EAAE,IAAI;SACf;QACD,OAAO,EAAK;YACV,IAAI,EAAM,QAAQ;YAClB,MAAM,EAAI,uBAAuB;YACjC,QAAQ,EAAE,IAAI;SACf;QACD,KAAK,EAAO;YACV,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,EAAE;YACb,QAAQ,EAAG,IAAI;SAChB;QACD,KAAK,EAAO;YACV,IAAI,EAAM,CAAE,QAAQ,EAAE,SAAS,CAAE;YACjC,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,iCAAa,CAAoB;oBACzD,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,GAAG,EAAS;YACV,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,EAAE;SACd;QACD,UAAU,EAAE;YACV,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAE,IAAI,CAAE;YAClB,QAAQ,EAAE,IAAI;SACf;KACF;CACF,CAAC"}