iproutejs 2.3.0

package/lib/commands/tunnel/prl.schema.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TunnelPrlSchema = void 0;
+const schemas_1 = require("../../common/constants/schemas");
+exports.TunnelPrlSchema = {
+    $id: schemas_1.SchemaIds.TunnelPrl,
+    type: 'object',
+    required: ['dev'],
+    properties: {
+        dev: {
+            type: 'string',
+            minLength: 1
+        },
+        'prl-default': {
+            type: 'string',
+            format: 'ip-or-any',
+            minLength: 1,
+            nullable: true
+        },
+        'prl-nodefault': {
+            type: 'string',
+            format: 'ip-or-any',
+            minLength: 1,
+            nullable: true
+        },
+        'prl-delete': {
+            type: 'string',
+            format: 'ip-or-any',
+            minLength: 1,
+            nullable: true
+        }
+    }
+};
+//# sourceMappingURL=prl.schema.js.map

package/lib/commands/tunnel/prl.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prl.schema.js","sourceRoot":"","sources":["../../../src/commands/tunnel/prl.schema.ts"],"names":[],"mappings":";;;AAEA,4DAA2D;AAG9C,QAAA,eAAe,GAAqC;IAC/D,GAAG,EAAS,mBAAS,CAAC,SAAS;IAC/B,IAAI,EAAQ,QAAQ;IACpB,QAAQ,EAAI,CAAC,KAAK,CAAC;IACnB,UAAU,EAAE;QACV,GAAG,EAAc;YACf,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;SACb;QACD,aAAa,EAAI;YACf,IAAI,EAAO,QAAQ;YACnB,MAAM,EAAK,WAAW;YACtB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;QACD,eAAe,EAAE;YACf,IAAI,EAAO,QAAQ;YACnB,MAAM,EAAK,WAAW;YACtB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;QACD,YAAY,EAAK;YACf,IAAI,EAAO,QAAQ;YACnB,MAAM,EAAK,WAAW;YACtB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;KACF;CACF,CAAC"}

package/lib/commands/tunnel.constants.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Tunnel available modes.
+ * @category Constants
+ */
+export declare enum TunnelModes {
+    Ipip = "ipip",
+    Sit = "sit",
+    Isatap = "isatap",
+    Gre = "gre",
+    Ip6ip6 = "ip6ip6",
+    Ipip6 = "ipip6",
+    Ip6gre = "ip6gre",
+    vti6 = "vti6",
+    Any = "any"
+}
+/**
+ * Tunnel Info.
+ * TODO: Need help to build this undocumented & comprehensive interface.
+ *
+ * @category Interfaces
+ */
+export interface TunnelInfo {
+}

package/lib/commands/tunnel.constants.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TunnelModes = void 0;
+/**
+ * Tunnel available modes.
+ * @category Constants
+ */
+var TunnelModes;
+(function (TunnelModes) {
+    // IPv4
+    TunnelModes["Ipip"] = "ipip";
+    TunnelModes["Sit"] = "sit";
+    TunnelModes["Isatap"] = "isatap";
+    TunnelModes["Gre"] = "gre";
+    //
+    // IPv6
+    //
+    TunnelModes["Ip6ip6"] = "ip6ip6";
+    TunnelModes["Ipip6"] = "ipip6";
+    TunnelModes["Ip6gre"] = "ip6gre";
+    TunnelModes["vti6"] = "vti6";
+    TunnelModes["Any"] = "any";
+})(TunnelModes || (exports.TunnelModes = TunnelModes = {}));
+//# sourceMappingURL=tunnel.constants.js.map

package/lib/commands/tunnel.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnel.constants.js","sourceRoot":"","sources":["../../src/commands/tunnel.constants.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAY,WAcX;AAdD,WAAY,WAAW;IACrB,OAAO;IACP,4BAAe,CAAA;IACf,0BAAc,CAAA;IACd,gCAAiB,CAAA;IACjB,0BAAc,CAAA;IACd,EAAE;IACF,OAAO;IACP,EAAE;IACF,gCAAiB,CAAA;IACjB,8BAAgB,CAAA;IAChB,gCAAiB,CAAA;IACjB,4BAAe,CAAA;IACf,0BAAc,CAAA;AAChB,CAAC,EAdW,WAAW,2BAAX,WAAW,QActB"}

package/lib/commands/tunnel.d.ts

@@ -0,0 +1,151 @@
+import Command from '../common/classes/command';
+import { Empty, GlobalOptions } from '../common/interfaces/common';
+import { TunnelAddOptions } from './tunnel/add.interfaces';
+import { TunnelInfo } from './tunnel.constants';
+import { TunnelPrlOptions } from './tunnel/prl.interfaces';
+import { Tunnel6rdOptions } from './tunnel/6rd.interfaces';
+/**
+ * Add a new tunnel.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { tunnel } from 'iproutejs';
+ * ```
+ *
+ * Create a new tunnel
+ * ```
+ * await tunnel.add({
+ *   name  : 'tun0',
+ *   mode  : TunnelModes.Gre,
+ *   remote: '203.0.113.4',
+ *   local : '203.0.113.5',
+ *   dev   : 'eth0'
+ * });
+ * ```
+ */
+export declare function add(options: TunnelAddOptions, globalOptions?: GlobalOptions): Promise<Command<TunnelAddOptions>>;
+/**
+ * Destroy a tunnel.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { tunnel } from 'iproutejs';
+ * ```
+ *
+ * Delete a tunnel
+ * ```
+ * await tunnel.del({
+ *   name: 'tun0'
+ * });
+ * ```
+ */
+export declare function del(options: TunnelAddOptions, globalOptions?: GlobalOptions): Promise<Command<TunnelAddOptions>>;
+/**
+ * Change an existing tunnel.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { tunnel } from 'iproutejs';
+ * ```
+ *
+ * Modify an existing tunnel
+ * ```
+ * await tunnel.change({
+ *   name  : 'tun0',
+ *   mode  : TunnelModes.Ipip,
+ *   remote: '203.0.113.6',
+ *   local : '203.0.113.7',
+ *   dev   : 'eth1'
+ * });
+ * ```
+ */
+export declare function change(options: TunnelAddOptions, globalOptions?: GlobalOptions): Promise<Command<TunnelAddOptions>>;
+/**
+ * List tunnels.
+ *
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { tunnel } from 'iproutejs';
+ * ```
+ *
+ * Show tunnels
+ * ```
+ * const entries = await tunnel.show({});
+ * ```
+ */
+export declare function show(globalOptions?: GlobalOptions): Promise<Command<Empty> | TunnelInfo[]>;
+/**
+ * Potential router list (ISATAP only).
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ */
+export declare function prl(options: TunnelPrlOptions, globalOptions?: GlobalOptions): Promise<Command<TunnelPrlOptions>>;
+/**
+ * Specifies the 6rd (IPv6 Rapid Deployment) tunneling mechanism.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { tunnel } from 'iproutejs';
+ * ```
+ *
+ * Configures 6rd tunneling mechanism.
+ * ```
+ * await tunnel.6rd({
+ *   dev        : 'eth0',
+ *   6rd_prefix : '2001:db8::'
+ * });
+ * ```
+ */
+export declare function v6Rd(options: Tunnel6rdOptions, globalOptions?: GlobalOptions): Promise<Command<Tunnel6rdOptions>>;
+declare const _default: {
+    add: typeof add;
+    del: typeof del;
+    change: typeof change;
+    show: typeof show;
+    prl: typeof prl;
+    v6Rd: typeof v6Rd;
+};
+export default _default;

package/lib/commands/tunnel.js

@@ -0,0 +1,210 @@
+"use strict";
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.v6Rd = exports.prl = exports.show = exports.change = exports.del = exports.add = void 0;
+const command_with_returned_data_1 = __importDefault(require("../common/classes/command-with-returned-data"));
+const command_1 = __importDefault(require("../common/classes/command"));
+const schemas_1 = require("../common/constants/schemas");
+const add_schema_1 = require("./tunnel/add.schema");
+const prl_schema_1 = require("./tunnel/prl.schema");
+const _6rd_schema_1 = require("./tunnel/6rd.schema");
+/**
+ * Add a new tunnel.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { tunnel } from 'iproutejs';
+ * ```
+ *
+ * Create a new tunnel
+ * ```
+ * await tunnel.add({
+ *   name  : 'tun0',
+ *   mode  : TunnelModes.Gre,
+ *   remote: '203.0.113.4',
+ *   local : '203.0.113.5',
+ *   dev   : 'eth0'
+ * });
+ * ```
+ */
+function add(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'tunnel', 'add'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.TunnelAdd, add_schema_1.TunnelAddSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.add = add;
+/**
+ * Destroy a tunnel.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { tunnel } from 'iproutejs';
+ * ```
+ *
+ * Delete a tunnel
+ * ```
+ * await tunnel.del({
+ *   name: 'tun0'
+ * });
+ * ```
+ */
+function del(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'tunnel', 'del'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.TunnelAdd, add_schema_1.TunnelAddSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.del = del;
+/**
+ * Change an existing tunnel.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { tunnel } from 'iproutejs';
+ * ```
+ *
+ * Modify an existing tunnel
+ * ```
+ * await tunnel.change({
+ *   name  : 'tun0',
+ *   mode  : TunnelModes.Ipip,
+ *   remote: '203.0.113.6',
+ *   local : '203.0.113.7',
+ *   dev   : 'eth1'
+ * });
+ * ```
+ */
+function change(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'tunnel', 'change'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.TunnelAdd, add_schema_1.TunnelAddSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.change = change;
+/**
+ * List tunnels.
+ *
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { tunnel } from 'iproutejs';
+ * ```
+ *
+ * Show tunnels
+ * ```
+ * const entries = await tunnel.show({});
+ * ```
+ */
+function show(globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'tunnel', 'show'];
+        const ipCmd = new command_with_returned_data_1.default(schemas_1.SchemaIds.Empty, schemas_1.EmptySchema, {}, Object.assign(Object.assign({}, globalOptions), { 
+            // Overrides for a better show.
+            '-details': true, '-statistics': true, '-json': true }), cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.show = show;
+/**
+ * Potential router list (ISATAP only).
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ */
+function prl(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'tunnel', 'prl'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.TunnelPrl, prl_schema_1.TunnelPrlSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.prl = prl;
+/**
+ * Specifies the 6rd (IPv6 Rapid Deployment) tunneling mechanism.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { tunnel } from 'iproutejs';
+ * ```
+ *
+ * Configures 6rd tunneling mechanism.
+ * ```
+ * await tunnel.6rd({
+ *   dev        : 'eth0',
+ *   6rd_prefix : '2001:db8::'
+ * });
+ * ```
+ */
+function v6Rd(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'tunnel', '6rd'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.Tunnel6rd, _6rd_schema_1.Tunnel6rdSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.v6Rd = v6Rd;
+exports.default = {
+    add,
+    del,
+    change,
+    show,
+    prl,
+    v6Rd
+};
+//# sourceMappingURL=tunnel.js.map

package/lib/commands/tunnel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tunnel.js","sourceRoot":"","sources":["../../src/commands/tunnel.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,8GAAmF;AACnF,wEAAgD;AAChD,yDAAqE;AAGrE,oDAAsD;AAEtD,oDAAsD;AAGtD,qDAAsD;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAsB,GAAG,CAAC,OAAyB,EACzB,gBAA+B,EAAE;;QAEzD,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAEpC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,SAAS,EACnB,4BAAe,EACf,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,kBAaC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,SAAsB,GAAG,CAAC,OAAyB,EACzB,gBAA+B,EAAE;;QAEzD,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAEpC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,SAAS,EACnB,4BAAe,EACf,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,kBAaC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAsB,MAAM,CAAC,OAAyB,EACzB,gBAA+B,EAAE;;QAE5D,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAEvC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,SAAS,EACnB,4BAAe,EACf,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,wBAaC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAsB,IAAI,CAAC,gBAA+B,EAAE;;QAE1D,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAErC,MAAM,KAAK,GAAG,IAAI,oCAAuB,CACvC,mBAAS,CAAC,KAAK,EACf,qBAAW,EACX,EAAE,kCAEG,aAAa;YAChB,+BAA+B;YAC/B,UAAU,EAAK,IAAI,EACnB,aAAa,EAAE,IAAI,EACnB,OAAO,EAAQ,IAAI,KAErB,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAgB,CAAC;IAC1C,CAAC;CAAA;AAlBD,oBAkBC;AAED;;;;;;;;GAQG;AACH,SAAsB,GAAG,CAAC,OAAyB,EACzB,gBAA+B,EAAE;;QAEzD,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAEpC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,SAAS,EACnB,4BAAe,EACf,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,kBAaC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAsB,IAAI,CAAC,OAAyB,EACzB,gBAA+B,EAAE;;QAE1D,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAEpC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,SAAS,EACnB,6BAAe,EACf,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,oBAaC;AAED,kBAAe;IACb,GAAG;IACH,GAAG;IACH,MAAM;IACN,IAAI;IACJ,GAAG;IACH,IAAI;CACL,CAAC"}

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

@@ -0,0 +1,25 @@
+import { TunTapTunnelModes } from '../tuntap.constants';
+/**
+ * Tunnel add options.
+ * @category Interfaces
+ */
+export interface TunTapTunnelAddOptions {
+    /** The physical device to attach this tunnel to. */
+    dev?: string;
+    /** Set the tunnel mode. */
+    mode: TunTapTunnelModes;
+    /** XXX */
+    user?: string | number;
+    /** XXX */
+    group?: string | number;
+    /** XXX */
+    one_queue?: true;
+    /** XXX */
+    pi?: true;
+    /** XXX */
+    vnet_hdr?: true;
+    /** XXX */
+    multi_queue?: true;
+    /** XXX */
+    name?: string;
+}

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

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

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

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

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

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

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

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TunTapAddSchema = void 0;
+const schemas_1 = require("../../common/constants/schemas");
+const tuntap_constants_1 = require("../tuntap.constants");
+exports.TunTapAddSchema = {
+    $id: schemas_1.SchemaIds.TunTapAdd,
+    type: 'object',
+    required: ['mode'],
+    properties: {
+        dev: {
+            type: 'string',
+            minLength: 1,
+            nullable: true
+        },
+        mode: {
+            type: 'string',
+            enum: Object.values(tuntap_constants_1.TunTapTunnelModes)
+        },
+        user: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    minLength: 1
+                },
+                {
+                    type: 'integer',
+                    minimum: 0
+                }
+            ]
+        },
+        group: {
+            type: ['string', 'integer'],
+            nullable: true,
+            anyOf: [
+                {
+                    type: 'string',
+                    minLength: 1,
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        },
+        one_queue: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        pi: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        vnet_hdr: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        multi_queue: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        name: {
+            type: 'string',
+            minLength: 1,
+            nullable: true
+        }
+    }
+};
+//# sourceMappingURL=add.schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"add.schema.js","sourceRoot":"","sources":["../../../src/commands/tuntap/add.schema.ts"],"names":[],"mappings":";;;AAEA,4DAA2D;AAE3D,0DAAwD;AAE3C,QAAA,eAAe,GAA2C;IACrE,GAAG,EAAS,mBAAS,CAAC,SAAS;IAC/B,IAAI,EAAQ,QAAQ;IACpB,QAAQ,EAAI,CAAC,MAAM,CAAC;IACpB,UAAU,EAAE;QACV,GAAG,EAAU;YACX,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;QACD,IAAI,EAAS;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,oCAAiB,CAAwB;SAC9D;QACD,IAAI,EAAS;YACX,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAO,QAAQ;oBACnB,SAAS,EAAE,CAAC;iBACb;gBACD;oBACE,IAAI,EAAK,SAAS;oBAClB,OAAO,EAAE,CAAC;iBACX;aACF;SACF;QACD,KAAK,EAAQ;YACX,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAO,QAAQ;oBACnB,SAAS,EAAE,CAAC;oBACZ,QAAQ,EAAG,IAAI;iBAChB;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,SAAS,EAAI;YACX,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,EAAE,EAAW;YACX,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,QAAQ,EAAK;YACX,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,WAAW,EAAE;YACX,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,IAAI,EAAS;YACX,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;KACF;CACF,CAAC"}

package/lib/commands/tuntap/show.interfaces.d.ts

@@ -0,0 +1,17 @@
+import { TunTapTunnelAddOptions } from './add.interfaces';
+/**
+ * Tunnel show options.
+ * @category Interfaces
+ */
+export type TunTapTunnelShowOptions = Partial<Pick<TunTapTunnelAddOptions, 'mode'>> & Omit<TunTapTunnelAddOptions, 'mode'>;
+/**
+ * Tunnel Info.
+ * TODO: Need help to build this undocumented & comprehensive interface.
+ *
+ * @category Interfaces
+ */
+export interface TunTapTunnelInfo {
+    ifname: string;
+    flags: string[];
+    processes: Array<any>;
+}

package/lib/commands/tuntap/show.interfaces.js

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

package/lib/commands/tuntap/show.interfaces.js.map

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

package/lib/commands/tuntap/show.schema.d.ts

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