iproutejs 2.3.0

package/lib/common/constants/schemas.d.ts

@@ -0,0 +1,52 @@
+import { JSONSchemaType } from 'ajv';
+import { Empty, FilePathRequiredGlobalOption, GlobalOptions, StdinRequiredGlobalOption } from '../interfaces/common';
+import { ComplexIpCommandTestOptions } from '../interfaces/tests';
+/**
+ * Schema ids.
+ *
+ * @category Constants
+ * @internal
+ */
+export declare enum SchemaIds {
+    Empty = "#empty-schema",
+    GlobalOptions = "#global-options",
+    FilePathGlobalOption = "#global-options-file-path",
+    StdinGlobalOption = "#global-options-stdin",
+    ComplexIpCommandTestOptions = "#complex-ip-command-test-options",
+    RoutingTablesOptions = "#routing-tables-options",
+    LinkAdd = "#link-add",
+    LinkDelete = "#link-delete",
+    LinkShow = "#link-show",
+    LinkSet = "#link-set",
+    AddressAdd = "#address-add",
+    AddressDelete = "#address-delete",
+    AddressFlush = "#address-flush",
+    AddressShow = "#address-show",
+    RuleAdd = "#rule-add",
+    RuleShow = "#rule-show",
+    RouteShow = "#route-show",
+    RouteGet = "#route-get",
+    RouteAdd = "#route-add",
+    Monitor = "#monitor",
+    AddrlabelAdd = "#addrlabel-add",
+    AddrlabelDel = "#addrlabel-del",
+    NeighbourAdd = "#neighbour-add",
+    NeighbourDel = "#neighbour-del",
+    NeighbourShow = "#neighbour-show",
+    NeighbourGet = "#neighbour-get",
+    NtableShow = "#ntable-show",
+    NtableChange = "#ntable-change",
+    TunnelAdd = "#tunnel-add",
+    Tunnel6rd = "#tunnel-6rd",
+    TunnelPrl = "#tunnel-prl",
+    TunTapAdd = "#tuntap-add",
+    TunTapShow = "#tuntap-show",
+    MaddressAdd = "#maddress-add",
+    MaddressShow = "#maddress-show",
+    MrouteShow = "#mroute-show"
+}
+export declare const GlobalOptionsSchema: JSONSchemaType<GlobalOptions>;
+export declare const FilePathGlobalOptionSchema: JSONSchemaType<FilePathRequiredGlobalOption>;
+export declare const StdinGlobalOptionSchema: JSONSchemaType<StdinRequiredGlobalOption>;
+export declare const EmptySchema: JSONSchemaType<Empty>;
+export declare const IpCommandTestOptionsSchema: JSONSchemaType<ComplexIpCommandTestOptions>;

package/lib/common/constants/schemas.js

@@ -0,0 +1,296 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IpCommandTestOptionsSchema = exports.EmptySchema = exports.StdinGlobalOptionSchema = exports.FilePathGlobalOptionSchema = exports.GlobalOptionsSchema = exports.SchemaIds = void 0;
+const tests_1 = require("./tests");
+/**
+ * Schema ids.
+ *
+ * @category Constants
+ * @internal
+ */
+var SchemaIds;
+(function (SchemaIds) {
+    SchemaIds["Empty"] = "#empty-schema";
+    SchemaIds["GlobalOptions"] = "#global-options";
+    SchemaIds["FilePathGlobalOption"] = "#global-options-file-path";
+    SchemaIds["StdinGlobalOption"] = "#global-options-stdin";
+    SchemaIds["ComplexIpCommandTestOptions"] = "#complex-ip-command-test-options";
+    SchemaIds["RoutingTablesOptions"] = "#routing-tables-options";
+    SchemaIds["LinkAdd"] = "#link-add";
+    SchemaIds["LinkDelete"] = "#link-delete";
+    SchemaIds["LinkShow"] = "#link-show";
+    SchemaIds["LinkSet"] = "#link-set";
+    SchemaIds["AddressAdd"] = "#address-add";
+    SchemaIds["AddressDelete"] = "#address-delete";
+    SchemaIds["AddressFlush"] = "#address-flush";
+    SchemaIds["AddressShow"] = "#address-show";
+    SchemaIds["RuleAdd"] = "#rule-add";
+    SchemaIds["RuleShow"] = "#rule-show";
+    SchemaIds["RouteShow"] = "#route-show";
+    SchemaIds["RouteGet"] = "#route-get";
+    SchemaIds["RouteAdd"] = "#route-add";
+    SchemaIds["Monitor"] = "#monitor";
+    SchemaIds["AddrlabelAdd"] = "#addrlabel-add";
+    SchemaIds["AddrlabelDel"] = "#addrlabel-del";
+    SchemaIds["NeighbourAdd"] = "#neighbour-add";
+    SchemaIds["NeighbourDel"] = "#neighbour-del";
+    SchemaIds["NeighbourShow"] = "#neighbour-show";
+    SchemaIds["NeighbourGet"] = "#neighbour-get";
+    SchemaIds["NtableShow"] = "#ntable-show";
+    SchemaIds["NtableChange"] = "#ntable-change";
+    SchemaIds["TunnelAdd"] = "#tunnel-add";
+    SchemaIds["Tunnel6rd"] = "#tunnel-6rd";
+    SchemaIds["TunnelPrl"] = "#tunnel-prl";
+    SchemaIds["TunTapAdd"] = "#tuntap-add";
+    SchemaIds["TunTapShow"] = "#tuntap-show";
+    SchemaIds["MaddressAdd"] = "#maddress-add";
+    SchemaIds["MaddressShow"] = "#maddress-show";
+    SchemaIds["MrouteShow"] = "#mroute-show";
+})(SchemaIds || (exports.SchemaIds = SchemaIds = {}));
+exports.GlobalOptionsSchema = {
+    $id: SchemaIds.GlobalOptions,
+    type: 'object',
+    properties: {
+        sudo: {
+            type: 'boolean',
+            default: false,
+            nullable: true
+        },
+        dryRun: {
+            type: 'boolean',
+            default: false,
+            nullable: true
+        },
+        filePath: {
+            type: 'string',
+            format: 'filepath',
+            nullable: true
+        },
+        stdin: {
+            type: 'string',
+            minLength: 1,
+            nullable: true
+        },
+        '-4': {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        '-6': {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        '-B': {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        '-M': {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        '-0': {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        '-oneline': {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        '-details': {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        '-statistics': {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        '-json': {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        '-tshort': {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        }
+    }
+};
+exports.FilePathGlobalOptionSchema = {
+    $id: SchemaIds.FilePathGlobalOption,
+    type: 'object',
+    required: ['filePath'],
+    additionalProperties: true,
+    properties: {
+        filePath: {
+            type: 'string',
+            format: 'filepath'
+        }
+    }
+};
+exports.StdinGlobalOptionSchema = {
+    $id: SchemaIds.StdinGlobalOption,
+    type: 'object',
+    required: ['stdin'],
+    additionalProperties: true,
+    properties: {
+        stdin: {
+            type: 'string',
+            minLength: 1
+        }
+    }
+};
+exports.EmptySchema = {
+    $id: SchemaIds.Empty,
+    type: 'object',
+    required: [],
+    additionalProperties: false,
+    properties: {}
+};
+exports.IpCommandTestOptionsSchema = {
+    $id: SchemaIds.ComplexIpCommandTestOptions,
+    type: 'object',
+    required: [
+        'aString',
+        'aNumber',
+        'anEnum',
+        'aFlag',
+        'noaFlag',
+        'aTuple',
+        'anArray',
+        'nestedInvisibleKey'
+    ],
+    properties: {
+        aString: {
+            type: 'string'
+        },
+        aNumber: {
+            type: 'number',
+            minimum: 0
+        },
+        anEnum: {
+            type: 'string',
+            enum: Object.values(tests_1.TestEnum)
+        },
+        aFlag: {
+            type: 'boolean'
+        },
+        noaFlag: {
+            type: 'boolean'
+        },
+        number: {
+            type: 'number',
+            keyless: true,
+            nullable: true
+        },
+        aTuple: {
+            type: 'array',
+            items: [
+                {
+                    type: 'number',
+                    minimum: 0
+                },
+                {
+                    type: 'number',
+                    minimum: 0
+                }
+            ],
+            minItems: 2,
+            maxItems: 2
+        },
+        anArray: {
+            type: 'array',
+            items: {
+                type: 'object',
+                required: ['aNumber'],
+                properties: {
+                    aNumber: {
+                        type: 'number'
+                    },
+                    aStringWithDefaultValue: {
+                        type: 'string',
+                        default: 'default-value',
+                        nullable: true
+                    }
+                }
+            }
+        },
+        nestedInvisibleKey: {
+            type: 'object',
+            keyless: true,
+            required: [
+                'aString',
+                'aNumber',
+                'anEnum',
+                'aFlag',
+                'noaFlag',
+                'aTuple',
+                'anArray'
+            ],
+            properties: {
+                aString: {
+                    type: 'string'
+                },
+                aNumber: {
+                    type: 'number',
+                    minimum: 0
+                },
+                anEnum: {
+                    type: 'string',
+                    enum: Object.values(tests_1.TestEnum)
+                },
+                aFlag: {
+                    type: 'boolean'
+                },
+                noaFlag: {
+                    type: 'boolean'
+                },
+                number: {
+                    type: 'number',
+                    keyless: true,
+                    nullable: true
+                },
+                aTuple: {
+                    type: 'array',
+                    items: [
+                        {
+                            type: 'number',
+                            minimum: 0
+                        },
+                        {
+                            type: 'number',
+                            minimum: 0
+                        }
+                    ],
+                    minItems: 2,
+                    maxItems: 2
+                },
+                anArray: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        required: ['aNumber'],
+                        properties: {
+                            aNumber: {
+                                type: 'number'
+                            },
+                            aStringWithDefaultValue: {
+                                type: 'string',
+                                default: 'default-value',
+                                nullable: true
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+};
+//# sourceMappingURL=schemas.js.map

package/lib/common/constants/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/common/constants/schemas.ts"],"names":[],"mappings":";;;AAKA,mCAAmC;AAEnC;;;;;GAKG;AACH,IAAY,SAmDX;AAnDD,WAAY,SAAS;IACnB,oCAA6C,CAAA;IAE7C,8CAA+C,CAAA;IAC/C,+DAAyD,CAAA;IACzD,wDAAqD,CAAA;IACrD,6EAAgE,CAAA;IAEhE,6DAAuD,CAAA;IAEvD,kCAAyC,CAAA;IACzC,wCAA4C,CAAA;IAC5C,oCAA0C,CAAA;IAC1C,kCAAyC,CAAA;IAEzC,wCAA4C,CAAA;IAC5C,8CAA+C,CAAA;IAC/C,4CAA8C,CAAA;IAC9C,0CAA6C,CAAA;IAE7C,kCAAyC,CAAA;IACzC,oCAA0C,CAAA;IAE1C,sCAA2C,CAAA;IAC3C,oCAA0C,CAAA;IAC1C,oCAA0C,CAAA;IAE1C,iCAAwC,CAAA;IAExC,4CAA8C,CAAA;IAC9C,4CAA8C,CAAA;IAE9C,4CAA8C,CAAA;IAC9C,4CAA8C,CAAA;IAC9C,8CAA+C,CAAA;IAC/C,4CAA8C,CAAA;IAE9C,wCAA4C,CAAA;IAC5C,4CAA8C,CAAA;IAE9C,sCAA2C,CAAA;IAC3C,sCAA2C,CAAA;IAC3C,sCAA2C,CAAA;IAE3C,sCAA2C,CAAA;IAC3C,wCAA4C,CAAA;IAE5C,0CAA6C,CAAA;IAC7C,4CAA8C,CAAA;IAE9C,wCAA4C,CAAA;AAC9C,CAAC,EAnDW,SAAS,yBAAT,SAAS,QAmDpB;AAEY,QAAA,mBAAmB,GAAkC;IAChE,GAAG,EAAS,SAAS,CAAC,aAAa;IACnC,IAAI,EAAQ,QAAQ;IACpB,UAAU,EAAE;QACV,IAAI,EAAW;YACb,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,KAAK;YACf,QAAQ,EAAE,IAAI;SACf;QACD,MAAM,EAAS;YACb,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,KAAK;YACf,QAAQ,EAAE,IAAI;SACf;QACD,QAAQ,EAAO;YACb,IAAI,EAAM,QAAQ;YAClB,MAAM,EAAI,UAAU;YACpB,QAAQ,EAAE,IAAI;SACf;QACD,KAAK,EAAU;YACb,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;QACD,IAAI,EAAW;YACb,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,IAAI,EAAW;YACb,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,IAAI,EAAW;YACb,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,IAAI,EAAW;YACb,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;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,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,OAAO,EAAQ;YACb,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,SAAS,EAAM;YACb,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;KACF;CACF,CAAC;AAEW,QAAA,0BAA0B,GAAiD;IACtF,GAAG,EAAmB,SAAS,CAAC,oBAAoB;IACpD,IAAI,EAAkB,QAAQ;IAC9B,QAAQ,EAAc,CAAC,UAAU,CAAC;IAClC,oBAAoB,EAAE,IAAI;IAC1B,UAAU,EAAY;QACpB,QAAQ,EAAE;YACR,IAAI,EAAI,QAAQ;YAChB,MAAM,EAAE,UAAU;SACnB;KACF;CACF,CAAC;AAEW,QAAA,uBAAuB,GAA8C;IAChF,GAAG,EAAmB,SAAS,CAAC,iBAAiB;IACjD,IAAI,EAAkB,QAAQ;IAC9B,QAAQ,EAAc,CAAC,OAAO,CAAC;IAC/B,oBAAoB,EAAE,IAAI;IAC1B,UAAU,EAAY;QACpB,KAAK,EAAE;YACL,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;SACb;KACF;CACF,CAAC;AAEW,QAAA,WAAW,GAA0B;IAChD,GAAG,EAAmB,SAAS,CAAC,KAAK;IACrC,IAAI,EAAkB,QAAQ;IAC9B,QAAQ,EAAc,EAAE;IACxB,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAY,EAAE;CACzB,CAAC;AAEW,QAAA,0BAA0B,GAAgD;IACrF,GAAG,EAAS,SAAS,CAAC,2BAA2B;IACjD,IAAI,EAAQ,QAAQ;IACpB,QAAQ,EAAI;QACV,SAAS;QACT,SAAS;QACT,QAAQ;QAER,OAAO;QACP,SAAS;QAET,QAAQ;QACR,SAAS;QAET,oBAAoB;KACrB;IACD,UAAU,EAAE;QACV,OAAO,EAAa;YAClB,IAAI,EAAE,QAAQ;SACf;QACD,OAAO,EAAa;YAClB,IAAI,EAAK,QAAQ;YACjB,OAAO,EAAE,CAAC;SACX;QACD,MAAM,EAAc;YAClB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,gBAAQ,CAAe;SAC5C;QACD,KAAK,EAAe;YAClB,IAAI,EAAE,SAAS;SAChB;QACD,OAAO,EAAa;YAClB,IAAI,EAAE,SAAS;SAChB;QACD,MAAM,EAAc;YAClB,IAAI,EAAM,QAAQ;YAClB,OAAO,EAAG,IAAI;YACd,QAAQ,EAAE,IAAI;SACf;QACD,MAAM,EAAc;YAClB,IAAI,EAAM,OAAO;YACjB,KAAK,EAAK;gBACR;oBACE,IAAI,EAAK,QAAQ;oBACjB,OAAO,EAAE,CAAC;iBACX;gBACD;oBACE,IAAI,EAAK,QAAQ;oBACjB,OAAO,EAAE,CAAC;iBACX;aACF;YACD,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,CAAC;SACZ;QACD,OAAO,EAAa;YAClB,IAAI,EAAG,OAAO;YACd,KAAK,EAAE;gBACL,IAAI,EAAQ,QAAQ;gBACpB,QAAQ,EAAI,CAAC,SAAS,CAAC;gBACvB,UAAU,EAAE;oBACV,OAAO,EAAkB;wBACvB,IAAI,EAAE,QAAQ;qBACf;oBACD,uBAAuB,EAAE;wBACvB,IAAI,EAAM,QAAQ;wBAClB,OAAO,EAAG,eAAe;wBACzB,QAAQ,EAAE,IAAI;qBACf;iBACF;aACF;SACF;QACD,kBAAkB,EAAE;YAClB,IAAI,EAAQ,QAAQ;YACpB,OAAO,EAAK,IAAI;YAChB,QAAQ,EAAI;gBACV,SAAS;gBACT,SAAS;gBACT,QAAQ;gBAER,OAAO;gBACP,SAAS;gBAET,QAAQ;gBACR,SAAS;aACV;YACD,UAAU,EAAE;gBACV,OAAO,EAAE;oBACP,IAAI,EAAE,QAAQ;iBACf;gBACD,OAAO,EAAE;oBACP,IAAI,EAAK,QAAQ;oBACjB,OAAO,EAAE,CAAC;iBACX;gBACD,MAAM,EAAG;oBACP,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,gBAAQ,CAAe;iBAC5C;gBACD,KAAK,EAAI;oBACP,IAAI,EAAE,SAAS;iBAChB;gBACD,OAAO,EAAE;oBACP,IAAI,EAAE,SAAS;iBAChB;gBACD,MAAM,EAAG;oBACP,IAAI,EAAM,QAAQ;oBAClB,OAAO,EAAG,IAAI;oBACd,QAAQ,EAAE,IAAI;iBACf;gBACD,MAAM,EAAG;oBACP,IAAI,EAAM,OAAO;oBACjB,KAAK,EAAK;wBACR;4BACE,IAAI,EAAK,QAAQ;4BACjB,OAAO,EAAE,CAAC;yBACX;wBACD;4BACE,IAAI,EAAK,QAAQ;4BACjB,OAAO,EAAE,CAAC;yBACX;qBACF;oBACD,QAAQ,EAAE,CAAC;oBACX,QAAQ,EAAE,CAAC;iBACZ;gBACD,OAAO,EAAE;oBACP,IAAI,EAAG,OAAO;oBACd,KAAK,EAAE;wBACL,IAAI,EAAQ,QAAQ;wBACpB,QAAQ,EAAI,CAAC,SAAS,CAAC;wBACvB,UAAU,EAAE;4BACV,OAAO,EAAkB;gCACvB,IAAI,EAAE,QAAQ;6BACf;4BACD,uBAAuB,EAAE;gCACvB,IAAI,EAAM,QAAQ;gCAClB,OAAO,EAAG,eAAe;gCACzB,QAAQ,EAAE,IAAI;6BACf;yBACF;qBACF;iBACF;aACF;SACF;KACF;CACF,CAAC"}

package/lib/common/constants/tests.d.ts

@@ -0,0 +1,4 @@
+export declare enum TestEnum {
+    ValueA = "value-a",
+    ValueB = "value-b"
+}

package/lib/common/constants/tests.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestEnum = void 0;
+var TestEnum;
+(function (TestEnum) {
+    TestEnum["ValueA"] = "value-a";
+    TestEnum["ValueB"] = "value-b";
+})(TestEnum || (exports.TestEnum = TestEnum = {}));
+//# sourceMappingURL=tests.js.map

package/lib/common/constants/tests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tests.js","sourceRoot":"","sources":["../../../src/common/constants/tests.ts"],"names":[],"mappings":";;;AAAA,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,8BAAkB,CAAA;IAClB,8BAAkB,CAAA;AACpB,CAAC,EAHW,QAAQ,wBAAR,QAAQ,QAGnB"}

package/lib/common/errors/command.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Error class to be used when the command throws an error.
+ * @category Errors
+ */
+export declare class CommandError extends Error {
+    /** Code to identify the error in `catch` clauses. */
+    code: string;
+    /** Command line that triggered the command error. */
+    cmd: string;
+    constructor(message: string, cmd: string);
+}

package/lib/common/errors/command.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandError = void 0;
+/**
+ * Error class to be used when the command throws an error.
+ * @category Errors
+ */
+class CommandError extends Error {
+    constructor(message, cmd) {
+        // 'Error' breaks prototype chain here.
+        super(message);
+        /** Code to identify the error in `catch` clauses. */
+        this.code = 'ERR_COMMAND_ERRORED';
+        // Fixing the break.
+        Object.setPrototypeOf(this, CommandError.prototype);
+        this.cmd = cmd;
+    }
+}
+exports.CommandError = CommandError;
+//# sourceMappingURL=command.js.map

package/lib/common/errors/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../../../src/common/errors/command.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,MAAa,YAAa,SAAQ,KAAK;IAOrC,YAAY,OAAe,EAAE,GAAW;QACtC,uCAAuC;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC;QARjB,qDAAqD;QACrD,SAAI,GAAG,qBAAqB,CAAC;QAQ3B,oBAAoB;QACpB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;QAEpD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;CACF;AAfD,oCAeC"}

package/lib/common/errors/parameters.d.ts

@@ -0,0 +1,16 @@
+import { ErrorObject } from 'ajv';
+/**
+ * Error class to be used when the provided options are invalid.
+ * @category Errors
+ */
+export declare class ParametersError extends Error {
+    /** Code to identify the error in `catch` clauses. */
+    code: string;
+    /**
+     * Detailed introspection on the encountered errors, useful to know exactly
+     * what failed in the options.
+     */
+    errors?: ErrorObject[] | null;
+    static message: string;
+    constructor(message: string, errors?: ErrorObject[] | null);
+}

package/lib/common/errors/parameters.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParametersError = void 0;
+/**
+ * Error class to be used when the provided options are invalid.
+ * @category Errors
+ */
+class ParametersError extends Error {
+    constructor(message, errors) {
+        // 'Error' breaks prototype chain here.
+        super(message);
+        /** Code to identify the error in `catch` clauses. */
+        this.code = 'ERR_INVALID_PARAMETERS';
+        // Fixing the break.
+        Object.setPrototypeOf(this, ParametersError.prototype);
+        this.errors = errors;
+    }
+}
+exports.ParametersError = ParametersError;
+ParametersError.message = 'Invalid parameters. Catch `e.errors` for details.';
+//# sourceMappingURL=parameters.js.map

package/lib/common/errors/parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameters.js","sourceRoot":"","sources":["../../../src/common/errors/parameters.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,MAAa,eAAgB,SAAQ,KAAK;IAYxC,YAAY,OAAe,EAAE,MAA6B;QACxD,uCAAuC;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC;QAbjB,qDAAqD;QACrD,SAAI,GAAG,wBAAwB,CAAC;QAa9B,oBAAoB;QACpB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;QAEvD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;;AAnBH,0CAoBC;AAVQ,uBAAO,GAAW,mDAAmD,AAA9D,CAA+D"}

package/lib/common/interfaces/common.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Global options for all commands.
+ * @category Interfaces
+ */
+export interface GlobalOptions {
+    /** @hidden */
+    [index: string]: boolean | string | undefined;
+    /**
+     * When provided, will prepend the command with `sudo`, which effectively instructs
+     * the OS to execute the command with elevated privileges.
+     */
+    sudo?: boolean;
+    /**
+     * If set, the command won't be executed, just the command line will be built.
+     * Useful for debugging since the command will return a Command class, which provides access
+     * to Command.cmdToExec for debugging.
+     */
+    dryRun?: boolean;
+    /** Required for certain commands that need a file path to create a file or consume it. */
+    filePath?: string;
+    /** Required for certain commands that need `stdin` input. */
+    stdin?: string;
+    /**
+     * Shortcut for `-family inet`.
+     *
+     * @remarks
+     * Specifies the protocol family to use.
+     */
+    '-4'?: true;
+    /**
+     * Shortcut for `-family inet6`.
+     *
+     * @remarks
+     * Specifies the protocol family to use.
+     */
+    '-6'?: true;
+    /**
+     * Shortcut for `-family bridge`.
+     *
+     * @remarks
+     * Specifies the protocol family to use.
+     */
+    '-B'?: true;
+    /**
+     * Shortcut for `-family mpls`.
+     *
+     * @remarks
+     * Specifies the protocol family to use.
+     */
+    '-M'?: true;
+    /**
+     * Shortcut for `-family link`.
+     *
+     * @remarks
+     * Specifies the protocol family to use.
+     */
+    '-0'?: true;
+    /**
+     * Output more detailed information.
+     * @hidden
+     */
+    '-details'?: true;
+    /**
+     * Output more information.
+     * @hidden
+     */
+    '-statistics'?: true;
+    /**
+     * Output results in JavaScript Object Notation (JSON).
+     * @hidden
+     */
+    '-json'?: true;
+    /**
+     * Used in `ip monitor`.
+     * Prints short timestamp before the event message on the same line in format:
+     * `[<YYYY>-<MM>-<DD>T<hh:mm:ss>.<ms>] <EVENT>`
+     * @hidden
+     */
+    '-tshort'?: true;
+    /**
+     * Output each record on a single line, replacing line feeds with the '\' character.
+     * This is convenient when you want to count records with `wc(1)` or to `grep(1)` the output.
+     * Used in `ip monitor`.
+     * Prints short timestamp before the event message on the same line in format:
+     * `[<YYYY>-<MM>-<DD>T<hh:mm:ss>.<ms>] <EVENT>`
+     * @hidden
+     */
+    '-oneline'?: true;
+}
+/**
+ * An empty interface.
+ * @category Interfaces
+ */
+export interface Empty {
+}
+/**
+ * Global options with required file path.
+ * @category Interfaces
+ */
+export type FilePathRequiredGlobalOption = Required<Pick<GlobalOptions, 'filePath'>>;
+/**
+ * Global options with required file path.
+ * @category Interfaces
+ */
+export type GlobalOptionsWithRequiredFilePath = GlobalOptions & FilePathRequiredGlobalOption;
+/**
+ * Global options with required stdin.
+ * @category Interfaces
+ */
+export type StdinRequiredGlobalOption = Required<Pick<GlobalOptions, 'stdin'>>;
+/**
+ * Global options with required stdin.
+ * @category Interfaces
+ */
+export type GlobalOptionsWithRequiredStdin = GlobalOptions & StdinRequiredGlobalOption;

package/lib/common/interfaces/common.js

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

package/lib/common/interfaces/common.js.map

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

package/lib/common/interfaces/monitor.d.ts

@@ -0,0 +1,17 @@
+import { MonitorObjects } from '../../commands/monitor.constants';
+/**
+ * The returned data emitted from {@link monitor}
+ * @category Interfaces
+ */
+export interface MonitorEmittedData {
+    /** The event timestamp in the format `<YYYY>-<MM>-<DD>T<hh:mm:ss>.<ms>`. */
+    timestamp: string;
+    /** The namespace which the event originated from. */
+    nsid: string;
+    /** The object that caused the update. */
+    object: MonitorObjects;
+    /** The lines that `ip monitor` gave to `stdout` when an update came, parsed in interesting lines. */
+    lines: string[];
+    /** The original line emitted by the command. */
+    originalLine: string;
+}

package/lib/common/interfaces/monitor.js

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

package/lib/common/interfaces/monitor.js.map

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

package/lib/common/interfaces/tests.d.ts

@@ -0,0 +1,33 @@
+import { TestEnum } from '../constants/tests';
+import { GlobalOptions } from './common';
+export interface ComplexIpCommandTestOptions extends ComplexIpCommandTestArgsOptions {
+    nestedInvisibleKey: ComplexIpCommandTestArgsOptions;
+}
+export interface ComplexIpCommandTestArgsOptions {
+    aString: string;
+    aNumber: number;
+    anEnum: TestEnum;
+    aFlag: boolean;
+    noaFlag: boolean;
+    number?: number;
+    aTuple: [number, number];
+    anArray: Array<{
+        aNumber: number;
+        aStringWithDefaultValue?: string;
+    }>;
+}
+export interface TestFixture<T_Options, T_GlobalOptions = GlobalOptions> {
+    description: string;
+    options: T_Options;
+    globalOptions?: T_GlobalOptions;
+    expectedCmd: Array<number | string>;
+    expectedCmdToExec: string;
+}
+export interface TestDefinition {
+    [index: string]: Array<{
+        operator: string;
+        testBattery: TestFixture<any>[];
+        method: Function;
+        skipOptions?: boolean;
+    }>;
+}

package/lib/common/interfaces/tests.js

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

package/lib/common/interfaces/tests.js.map

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

package/lib/common/misc.d.ts

@@ -0,0 +1,4 @@
+import { JSONSchemaType } from 'ajv';
+import { SchemaIds } from './constants/schemas';
+/** @internal */
+export declare function validate<T_Options>(schemaId: SchemaIds, schema: JSONSchemaType<T_Options>, options: T_Options): void;