iproutejs 2.3.0

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

@@ -0,0 +1,182 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuleAddSchema = void 0;
+const schemas_1 = require("../../common/constants/schemas");
+const rule_constants_1 = require("../rule.constants");
+exports.RuleAddSchema = {
+    $id: schemas_1.SchemaIds.RuleAdd,
+    type: 'object',
+    required: [],
+    properties: {
+        type: {
+            type: 'string',
+            enum: Object.values(rule_constants_1.RuleTypes),
+            nullable: true
+        },
+        not: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        from: {
+            type: 'string',
+            format: 'ip-with-optional-mask',
+            nullable: true
+        },
+        to: {
+            type: 'string',
+            format: 'ip-with-optional-mask',
+            nullable: true
+        },
+        tos: {
+            type: 'integer',
+            nullable: true,
+            minimum: 0,
+            maximum: 255
+        },
+        fwmark: {
+            type: 'string',
+            nullable: true,
+            pattern: '^(0x[0-9a-fA-F]+|[0-9]+)(/(0x[0-9a-fA-F]+|[0-9]+))?$'
+        },
+        iif: {
+            type: 'string',
+            minLength: 1,
+            maxLength: 15,
+            nullable: true
+        },
+        oif: {
+            type: 'string',
+            minLength: 1,
+            maxLength: 15,
+            nullable: true
+        },
+        l3mdev: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        uidrange: {
+            type: 'string',
+            minLength: 1,
+            pattern: '^[0-9]+-[0-9]+$',
+            nullable: true
+        },
+        ipproto: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    minLength: 1,
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        },
+        sport: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    pattern: '^[0-9]+-[0-9]+$',
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        },
+        dport: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    pattern: '^[0-9]+-[0-9]+$',
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        },
+        preference: {
+            type: 'integer',
+            minimum: 0,
+            nullable: true
+        },
+        tun_id: {
+            type: 'integer',
+            minimum: 0,
+            nullable: true
+        },
+        table: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    enum: Object.values(rule_constants_1.RoutingTables),
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        },
+        protocol: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    minLength: 1,
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        },
+        nat: {
+            type: 'string',
+            format: 'ip',
+            nullable: true
+        },
+        realms: {
+            type: 'string',
+            pattern: '^[0-9]+(/[0-9]+)?$',
+            nullable: true
+        },
+        goto: {
+            type: 'integer',
+            minimum: 0,
+            nullable: true
+        },
+        suppress_prefixlength: {
+            type: 'integer',
+            minimum: 0,
+            nullable: true
+        },
+        suppress_ifgroup: {
+            type: 'integer',
+            minimum: 0,
+            nullable: true
+        }
+    }
+};
+//# sourceMappingURL=add.schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"add.schema.js","sourceRoot":"","sources":["../../../src/commands/rule/add.schema.ts"],"names":[],"mappings":";;;AAEA,4DAA0E;AAC1E,sDAA6D;AAGhD,QAAA,aAAa,GAAmC;IAC3D,GAAG,EAAS,mBAAS,CAAC,OAAO;IAC7B,IAAI,EAAQ,QAAQ;IACpB,QAAQ,EAAI,EAAE;IACd,UAAU,EAAE;QACV,IAAI,EAAmB;YACrB,IAAI,EAAM,QAAQ;YAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,0BAAS,CAAgB;YACjD,QAAQ,EAAE,IAAI;SACf;QACD,GAAG,EAAoB;YACrB,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,IAAI,EAAmB;YACrB,IAAI,EAAM,QAAQ;YAClB,MAAM,EAAI,uBAAuB;YACjC,QAAQ,EAAE,IAAI;SACf;QACD,EAAE,EAAqB;YACrB,IAAI,EAAM,QAAQ;YAClB,MAAM,EAAI,uBAAuB;YACjC,QAAQ,EAAE,IAAI;SACf;QACD,GAAG,EAAoB;YACrB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,GAAG;SACd;QACD,MAAM,EAAiB;YACrB,IAAI,EAAM,QAAQ;YAClB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAG,sDAAsD;SACjE;QACD,GAAG,EAAoB;YACrB,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,EAAE;YACb,QAAQ,EAAG,IAAI;SAChB;QACD,GAAG,EAAoB;YACrB,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,EAAE;YACb,QAAQ,EAAG,IAAI;SAChB;QACD,MAAM,EAAiB;YACrB,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,QAAQ,EAAe;YACrB,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,OAAO,EAAI,iBAAiB;YAC5B,QAAQ,EAAG,IAAI;SAChB;QACD,OAAO,EAAgB;YACrB,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,KAAK,EAAkB;YACrB,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,OAAO,EAAG,iBAAiB;oBAC3B,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,KAAK,EAAkB;YACrB,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,OAAO,EAAG,iBAAiB;oBAC3B,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,UAAU,EAAmB;YAC3B,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,MAAM,EAAiB;YACrB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,KAAK,EAAkB;YACrB,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,8BAAa,CAAoB;oBACzD,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,QAAQ,EAAe;YACrB,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,GAAG,EAAoB;YACrB,IAAI,EAAM,QAAQ;YAClB,MAAM,EAAI,IAAI;YACd,QAAQ,EAAE,IAAI;SACf;QACD,MAAM,EAAiB;YACrB,IAAI,EAAM,QAAQ;YAClB,OAAO,EAAG,oBAAoB;YAC9B,QAAQ,EAAE,IAAI;SACf;QACD,IAAI,EAAmB;YACrB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,qBAAqB,EAAE;YACrB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,gBAAgB,EAAO;YACrB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;KACF;CACF,CAAC"}

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

@@ -0,0 +1,86 @@
+import { RoutingTables, RuleTypes } from '../rule.constants';
+/**
+ * Rule show options.
+ * @category Interfaces
+ */
+export interface RuleShowOptions {
+    /** The type of this rule. */
+    type?: RuleTypes;
+    /** Invert the rule. */
+    not?: true;
+    /** Select the source prefix to match. */
+    from?: string;
+    /** Select the destination prefix to match. */
+    to?: string;
+    /** Select the TOS value to match. */
+    tos?: number;
+    /** Select the fwmark value to match. */
+    fwmark?: string;
+    /**
+     * Select the incoming device to match.
+     *
+     * If the interface is loopback, the rule only matches packets originating from this host.
+     * This means that you may create separate routing tables for forwarded and local packets and, hence,
+     * completely segregate them.
+     */
+    iif?: string;
+    /**
+     * Sselect the outgoing device to match.
+     * The outgoing interface is only available  for packets originating from local sockets that are bound to a device.
+     */
+    oif?: string;
+    /**
+     * The priority of this rule.
+     *
+     * PREFERENCE is an unsigned integer value, higher number means lower priority, and rules get processed in
+     * order of increasing number.
+     *
+     * Each rule should have an explicitly set unique priority value.  The options preference and order are synonyms
+     * with priority.
+     */
+    preference?: number;
+    /** Pertains to layer 3 master device-based routing, particularly relevant when using Virtual Routing and Forwarding (VRF) tables. */
+    l3mdev?: true;
+    /** Select the uid value to match. */
+    uidrange?: string;
+    /** Select the ip protocol value to match. */
+    ipproto?: string | number;
+    /**
+     * Select the source port value to match.
+     * Supports port range.
+     */
+    sport?: string | number;
+    /**
+     * Select the destination port value to match.
+     * Supports port range.
+     */
+    dport?: string | number;
+    /**
+     *  Attribute is used to match packets based on their tunnel ID, typically relevant for
+     *  VXLAN (Virtual eXtensible Local Area Network) or other tunneling protocols that utilize tunnel IDs.
+     *  The tunnel ID helps identify individual tunnels in scenarios where multiple tunnels are used.
+     */
+    tun_id?: number;
+    /**
+     * The routing table identifier to lookup if the rule selector matches.
+     * It is also possible to use lookup instead of table.
+     */
+    table?: number | RoutingTables;
+    /**
+     * The routing protocol who installed the rule in question.
+     * As an example when zebra installs a rule it would get RTPROT_ZEBRA as the installing protocol.
+     */
+    protocol?: string | number;
+}
+/**
+ * Rule info.
+ * TODO: Need help to build this undocumented & comprehensive interface.
+ *
+ * @category Interfaces
+ */
+export interface RuleInfo {
+    priority: number;
+    src: string;
+    table: RoutingTables | string;
+    protocol: string | number;
+}

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

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

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

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

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

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

package/lib/commands/rule/show.schema.js

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuleShowSchema = void 0;
+const schemas_1 = require("../../common/constants/schemas");
+const rule_constants_1 = require("../rule.constants");
+exports.RuleShowSchema = {
+    $id: schemas_1.SchemaIds.RuleShow,
+    type: 'object',
+    required: [],
+    properties: {
+        type: {
+            type: 'string',
+            enum: Object.values(rule_constants_1.RuleTypes),
+            nullable: true
+        },
+        not: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        from: {
+            type: 'string',
+            format: 'ip-with-optional-mask',
+            nullable: true
+        },
+        to: {
+            type: 'string',
+            format: 'ip-with-optional-mask',
+            nullable: true
+        },
+        tos: {
+            type: 'integer',
+            nullable: true,
+            minimum: 0,
+            maximum: 255
+        },
+        fwmark: {
+            type: 'string',
+            nullable: true,
+            pattern: '^(0x[0-9a-fA-F]+|[0-9]+)(/(0x[0-9a-fA-F]+|[0-9]+))?$'
+        },
+        iif: {
+            type: 'string',
+            minLength: 1,
+            maxLength: 15,
+            nullable: true
+        },
+        oif: {
+            type: 'string',
+            minLength: 1,
+            maxLength: 15,
+            nullable: true
+        },
+        l3mdev: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        uidrange: {
+            type: 'string',
+            minLength: 1,
+            pattern: '^[0-9]+-[0-9]+$',
+            nullable: true
+        },
+        ipproto: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    minLength: 1,
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        },
+        sport: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    pattern: '^[0-9]+-[0-9]+$',
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        },
+        dport: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    pattern: '^[0-9]+-[0-9]+$',
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        },
+        preference: {
+            type: 'integer',
+            minimum: 0,
+            nullable: true
+        },
+        tun_id: {
+            type: 'integer',
+            minimum: 0,
+            nullable: true
+        },
+        table: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    enum: Object.values(rule_constants_1.RoutingTables),
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        },
+        protocol: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    minLength: 1,
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        }
+    }
+};
+//# sourceMappingURL=show.schema.js.map

package/lib/commands/rule/show.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"show.schema.js","sourceRoot":"","sources":["../../../src/commands/rule/show.schema.ts"],"names":[],"mappings":";;;AAEA,4DAA0E;AAC1E,sDAA6D;AAGhD,QAAA,cAAc,GAAoC;IAC7D,GAAG,EAAS,mBAAS,CAAC,QAAQ;IAC9B,IAAI,EAAQ,QAAQ;IACpB,QAAQ,EAAI,EAAE;IACd,UAAU,EAAE;QACV,IAAI,EAAQ;YACV,IAAI,EAAM,QAAQ;YAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,0BAAS,CAAgB;YACjD,QAAQ,EAAE,IAAI;SACf;QACD,GAAG,EAAS;YACV,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,IAAI,EAAQ;YACV,IAAI,EAAM,QAAQ;YAClB,MAAM,EAAI,uBAAuB;YACjC,QAAQ,EAAE,IAAI;SACf;QACD,EAAE,EAAU;YACV,IAAI,EAAM,QAAQ;YAClB,MAAM,EAAI,uBAAuB;YACjC,QAAQ,EAAE,IAAI;SACf;QACD,GAAG,EAAS;YACV,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,GAAG;SACd;QACD,MAAM,EAAM;YACV,IAAI,EAAM,QAAQ;YAClB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAG,sDAAsD;SACjE;QACD,GAAG,EAAS;YACV,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,EAAE;YACb,QAAQ,EAAG,IAAI;SAChB;QACD,GAAG,EAAS;YACV,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,EAAE;YACb,QAAQ,EAAG,IAAI;SAChB;QACD,MAAM,EAAM;YACV,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,QAAQ,EAAI;YACV,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,OAAO,EAAI,iBAAiB;YAC5B,QAAQ,EAAG,IAAI;SAChB;QACD,OAAO,EAAK;YACV,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,KAAK,EAAO;YACV,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,OAAO,EAAG,iBAAiB;oBAC3B,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,KAAK,EAAO;YACV,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,OAAO,EAAG,iBAAiB;oBAC3B,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,UAAU,EAAE;YACV,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,MAAM,EAAM;YACV,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,KAAK,EAAO;YACV,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,8BAAa,CAAoB;oBACzD,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,QAAQ,EAAI;YACV,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;KACF;CACF,CAAC"}

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

@@ -0,0 +1,34 @@
+/**
+ * Routing table special names.
+ * @category Constants
+ */
+export declare enum RoutingTables {
+    /**
+     * The `local` table is a special routing table containing high priority control routes for local
+     * and broadcast addresses.
+     */
+    Local = "local",
+    /** The `main` table is the normal routing table containing all non-policy routes.  */
+    Main = "main",
+    /**
+     * The `default` table is empty.
+     * It is reserved for some post-processing if no previous default rules selected the packet.
+     */
+    Default = "default"
+}
+/**
+ * Rule special values.
+ * @category Constants
+ */
+export declare enum RuleTypes {
+    /** The rule prescribes to return the route found in the routing table referenced by the rule. */
+    Unicast = "unicast",
+    /** The rule prescribes to silently drop the packet. */
+    Blackhole = "blackhole",
+    /** The rule prescribes to generate a 'Network is unreachable' error. */
+    Unreachable = "unreachable",
+    /** The rule prescribes to generate 'Communication is administratively prohibited' error. */
+    Prohibit = "prohibit",
+    /** The rule prescribes to translate the source address of the IP packet into some other value. */
+    Nat = "nat"
+}

package/lib/commands/rule.constants.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuleTypes = exports.RoutingTables = void 0;
+/**
+ * Routing table special names.
+ * @category Constants
+ */
+var RoutingTables;
+(function (RoutingTables) {
+    /**
+     * The `local` table is a special routing table containing high priority control routes for local
+     * and broadcast addresses.
+     */
+    RoutingTables["Local"] = "local";
+    /** The `main` table is the normal routing table containing all non-policy routes.  */
+    RoutingTables["Main"] = "main";
+    /**
+     * The `default` table is empty.
+     * It is reserved for some post-processing if no previous default rules selected the packet.
+     */
+    RoutingTables["Default"] = "default";
+})(RoutingTables || (exports.RoutingTables = RoutingTables = {}));
+/**
+ * Rule special values.
+ * @category Constants
+ */
+var RuleTypes;
+(function (RuleTypes) {
+    /** The rule prescribes to return the route found in the routing table referenced by the rule. */
+    RuleTypes["Unicast"] = "unicast";
+    /** The rule prescribes to silently drop the packet. */
+    RuleTypes["Blackhole"] = "blackhole";
+    /** The rule prescribes to generate a 'Network is unreachable' error. */
+    RuleTypes["Unreachable"] = "unreachable";
+    /** The rule prescribes to generate 'Communication is administratively prohibited' error. */
+    RuleTypes["Prohibit"] = "prohibit";
+    /** The rule prescribes to translate the source address of the IP packet into some other value. */
+    RuleTypes["Nat"] = "nat";
+})(RuleTypes || (exports.RuleTypes = RuleTypes = {}));
+//# sourceMappingURL=rule.constants.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rule.constants.js","sourceRoot":"","sources":["../../src/commands/rule.constants.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAY,aAaX;AAbD,WAAY,aAAa;IACvB;;;OAGG;IACH,gCAAiB,CAAA;IACjB,sFAAsF;IACtF,8BAAgB,CAAA;IAChB;;;OAGG;IACH,oCAAmB,CAAA;AACrB,CAAC,EAbW,aAAa,6BAAb,aAAa,QAaxB;AAED;;;GAGG;AACH,IAAY,SAWX;AAXD,WAAY,SAAS;IACnB,iGAAiG;IACjG,gCAAuB,CAAA;IACvB,uDAAuD;IACvD,oCAAyB,CAAA;IACzB,wEAAwE;IACxE,wCAA2B,CAAA;IAC3B,4FAA4F;IAC5F,kCAAwB,CAAA;IACxB,kGAAkG;IAClG,wBAAmB,CAAA;AACrB,CAAC,EAXW,SAAS,yBAAT,SAAS,QAWpB"}

package/lib/commands/rule.d.ts

@@ -0,0 +1,143 @@
+import Command from '../common/classes/command';
+import { Empty, GlobalOptions, GlobalOptionsWithRequiredFilePath } from '../common/interfaces/common';
+import { RuleAddOptions } from './rule/add.interfaces';
+import { RuleInfo, RuleShowOptions } from './rule/show.interfaces';
+/**
+ * Insert a new rule.
+ *
+ * Warning: Changes to the RPDB made with these commands do not become active immediately.
+ * It is assumed that after a script finishes a batch of updates, it flushes the routing cache with
+ * `ip route flush cache`.
+ *
+ * @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 { rule } from 'iproutejs';
+ * ```
+ *
+ * Unicast type rule (the default if not specified)
+ * ```
+ * await rule.add({
+ *   from:	      '192.203.80.0/24',
+ *   table:	  300,
+ *   preference: 220
+ * });
+ * ```
+ *
+ * NAT type rule
+ * ```
+ * await rule.add({
+ *   from:	        '193.233.7.83',
+ *   table:	    1,
+ *   preference:   320,
+ *   nat:		    '192.203.80.144'
+ * });
+ * ```
+ */
+export declare function add(options: RuleAddOptions, globalOptions?: GlobalOptions): Promise<Command<RuleAddOptions>>;
+/**
+ * Delete a rule.
+ *
+ * @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 { rule } from 'iproutejs';
+ * ```
+ *
+ * Delete the unused default rule
+ * ```
+ * await rule.del({
+ *   preference: 32767
+ * });
+ * ```
+ */
+export declare function del(options: RuleAddOptions, globalOptions?: GlobalOptions): Promise<Command<RuleAddOptions>>;
+/**
+ * Save rule configuration into a file.
+ *
+ * @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 save(globalOptions: GlobalOptionsWithRequiredFilePath): Promise<Command<Empty>>;
+/**
+ * Restore rule configuration from a file previously generated by {@link save}.
+ *
+ * @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 restore(globalOptions: GlobalOptionsWithRequiredFilePath): Promise<Command<Empty>>;
+/**
+ * Deletes all rules.
+ *
+ * Warning: Changes to the RPDB made with these commands do not become active immediately.
+ * It is assumed that after a script finishes a batch of updates, it flushes the routing cache with
+ * `ip route flush cache`.
+ *
+ * @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 { rule } from 'iproutejs';
+ * ```
+ *
+ * Flush the rules
+ * ```
+ * await rule.flush();
+ * ```
+ */
+export declare function flush(globalOptions?: GlobalOptions): Promise<Command<Empty>>;
+/**
+ * Shows installed rules.
+ *
+ * @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 { rule } from 'iproutejs';
+ * ```
+ *
+ * Show all rules
+ * ```
+ * const rules = await rule.show();
+ * ```
+ */
+export declare function show(options?: RuleShowOptions, globalOptions?: GlobalOptions): Promise<Command<RuleShowOptions> | RuleInfo[]>;
+declare const _default: {
+    add: typeof add;
+    del: typeof del;
+    save: typeof save;
+    restore: typeof restore;
+    flush: typeof flush;
+    show: typeof show;
+    list: typeof show;
+};
+export default _default;