@takodotid/circuit 0.34.3 → 0.36.0

package/dist/types/adapters/devices/fortios/render.d.ts

@@ -1,38 +0,0 @@
-import type { Device, Helper, Severity } from "../../../schema";
-/** Where the pre-login banner's text is kept. */
-export declare const BANNER = "system replacemsg admin \"pre_admin-disclaimer-text\"";
-/** Every section Circuit manages, in the order a change goes in: what others name comes first. */
-export declare const SECTIONS: readonly ["vpn certificate local", "vpn certificate ca", "system global", "system replacemsg admin \"pre_admin-disclaimer-text\"", "system settings", "system accprofile", "system admin", "system interface", "system gre-tunnel", "system vxlan", "system dns", "system dns-server", "system ntp", "system snmp sysinfo", "system snmp community", "system snmp user", "log memory setting", "log memory filter", "log disk setting", ...string[], "system sflow", "system netflow", "system dhcp server", "router static", "router static6", "router prefix-list", "router prefix-list6", "router community-list", "router route-map", "router ospf", "router ospf6", "router bgp", "system session-helper", "firewall address", "firewall address6", "firewall addrgrp", "firewall addrgrp6", "firewall service custom", "firewall ippool", "firewall vip", "firewall policy", "firewall policy6", "firewall local-in-policy", "firewall local-in-policy6", "firewall central-snat-map", "firewall acl", "firewall acl6"];
-export type Section = (typeof SECTIONS)[number];
-/** Sections `show` prints without what matters, which `show full-configuration` prints: a certificate's text. */
-export declare const FULL: readonly string[];
-/** The zone number for an IANA zone. UTC when the config names none. */
-export declare function zoneOf(timezone?: string): string | undefined;
-/** What each role may do: the factory profile for an admin, and a profile Circuit adds for the others. */
-export declare const PROFILE: {
-    readonly admin: "super_admin";
-    readonly operator: "circuit-operator";
-    readonly "read-only": "circuit-read-only";
-};
-/** The most public keys a user holds. */
-export declare const SSH_KEYS = 3;
-/** The most resolvers the device and a DHCP server hold, per family. */
-export declare const RESOLVERS: {
-    readonly device: 2;
-    readonly dhcp: 4;
-};
-/** The most syslog collectors the device sends to. */
-export declare const COLLECTORS = 4;
-/** The most VRFs the device holds besides its default table. */
-export declare const VRFS = 31;
-/** A severity as the platform names it. */
-export declare const LEVEL: Record<Severity, string>;
-/** The helpers the factory runs, by the name a config gives them: protocol and port of each. */
-export declare const HELPERS: Partial<Record<Helper, readonly [string, number, number][]>>;
-/** Speed by the platform's spelling, for each class a port's cage takes. */
-export declare const SPEEDS: Record<string, Partial<Record<string, string>>>;
-/** The management address of a device in transparent mode, which is reached only through its console: link-local, on no network it can reach. */
-export declare const TRANSPARENT_MANAGEIP = "169.254.0.1/255.255.255.255";
-export declare function render(device: Device): string;
-/** The one port or LAG that carries a VLAN tagged, which its VLAN interface sits on. `unsupported()` refuses any other case. */
-export declare function vlanParent(device: Device, vlan: string): string | undefined;

package/dist/types/adapters/devices/fortios/routing.d.ts

@@ -1,32 +0,0 @@
-import type { Device, Family, Neighbor, NeighborSettings, PolicyRule } from "../../../schema";
-import { Block } from "./tree";
-type AnyRule = PolicyRule<string, string>;
-type AnyNeighbor = Neighbor<string, string>;
-/** The route map a session takes when its config states none, so it learns or announces nothing. */
-export declare const REJECT_ALL = "circuit-reject-all";
-/** The start of the comment on a prefix list `refresh` fills. The plan keeps the entries the device holds in one. */
-export declare const FILLED = "Filled by circuit refresh";
-/** The table a prefix list of one family sits in. */
-export declare const PREFIX_LIST: {
-    readonly ipv4: "router prefix-list";
-    readonly ipv6: "router prefix-list6";
-};
-/** The longest prefix of each family. */
-export declare const BITS: {
-    readonly ipv4: 32;
-    readonly ipv6: 128;
-};
-/** A neighbor's settings with its group's beneath them. */
-export declare function neighborSettings(device: Device, neighbor: AnyNeighbor): NeighborSettings<string>;
-/** The families a session carries: its own, or the family of its address. */
-export declare function familiesOfNeighbor(device: Device, neighbor: AnyNeighbor): Family[];
-/** Whether OSPF or BGP detects a dead neighbor with BFD, which the device then runs. */
-export declare function usesBfd(device: Device): boolean;
-export declare function routing(root: Block, device: Device): void;
-/** The family a rule is limited to, by its match: a family, a prefix, or a prefix set of one family. */
-export declare function familyOfRule(device: Device, rule: AnyRule): Family | undefined;
-/** A policy's rules with each call replaced by the rules it calls, in order. A called policy that decides nothing hands back to the caller. */
-export declare function flatten(device: Device, policy: string, seen?: string[]): AnyRule[];
-/** Routing the platform cannot express, or that this adapter does not yet write. */
-export declare function routingGaps(device: Device): string[];
-export {};

package/dist/types/adapters/devices/fortios/tree.d.ts

@@ -1,33 +0,0 @@
-/** A setting the device prints as `unset <key>`, a key it holds empty on purpose, such as an ICMP service's type. */
-export declare const UNSET = "\0unset";
-/** One `edit` of a table: its name as written, and what it holds. */
-export type Entry = {
-    id: string;
-    block: Block;
-};
-export declare class Block {
-    readonly settings: Map<string, string>;
-    readonly blocks: Map<string, Block>;
-    readonly entries: Map<string, Entry>;
-    /** Set a key. A value of several words is written as given. */
-    set(key: string, value: string | number): this;
-    /** The nested `config` block with this header, created when absent. */
-    block(header: string): Block;
-    /** The table entry with this name, created when absent. A name is quoted unless it is a number, or the table prints it bare, such as an OSPF area or an IPv6 prefix. */
-    entry(id: string | number, plain?: boolean): Block;
-    isEmpty(): boolean;
-}
-/** A string as the CLI takes it, in double quotes. */
-export declare function quote(text: string): string;
-/** Each of several strings quoted, as a list setting takes them. */
-export declare const quoteAll: (texts: readonly string[]) => string;
-/** A value's words; a quoted string is one word with its quotes. */
-export declare function wordsOf(value: string): string[];
-/** A word as the device means it, without quotes or escapes. */
-export declare function bare(word: string): string;
-/** The lines that build a block, at an indent, in the form `show` prints and the CLI takes. */
-export declare function linesOf(block: Block, indent?: string): string[];
-/** The whole configuration: each top-level block as `config <section>` to `end`. */
-export declare function print(root: Block): string;
-/** The tree of what `show` printed. Lines that are not configuration, such as the version header, are skipped. */
-export declare function parse(text: string): Block;

package/dist/types/adapters/devices/index.d.ts

@@ -1,3 +0,0 @@
-import type { DeviceAdapter } from "./types";
-/** Every platform the framework can render and apply, by name. */
-export declare const adapters: Record<string, DeviceAdapter>;

package/dist/types/adapters/devices/junos/bgp.d.ts

@@ -1,11 +0,0 @@
-import type { Device, Neighbor, NeighborSettings } from "../../../schema";
-import { type Statements } from "./render";
-type AnyNeighbor = Neighbor<string, string>;
-/** The policy a session uses when it states none, so that it learns or announces nothing. */
-export declare const REJECT_ALL = "circuit-reject-all";
-/** A comment in the render naming a path whose statements `refresh` fills, so the plan keeps what the device holds there. */
-export declare const GENERATED = "# generated ";
-/** A neighbor's settings with its group's beneath them. */
-export declare function settingsOf(device: Device, neighbor: AnyNeighbor): NeighborSettings<string>;
-export declare function renderBgp(out: Statements, device: Device): void;
-export {};

package/dist/types/adapters/devices/junos/index.d.ts

@@ -1,42 +0,0 @@
-import type { Client, ClientChannel } from "ssh2";
-import type { Device, Family } from "../../../schema";
-import { type ConsoleDialect } from "../../../transport/console";
-import type { ApplyOptions, DeviceAdapter, Plan, ReadOptions } from "../types";
-/** A statement's words; a quoted value is one word with its quotes. */
-export declare function wordsOf(statement: string): string[];
-/** The device prints a password as a hash, an SNMP key as a reversible cipher, and a community as itself. None leave the read. */
-export declare function scrub(text: string): string;
-/** The configuration's statements from what `show configuration | display set` printed. */
-export declare function clean(output: string): string;
-/**
- * What changes, by section.
- *
- * A statement the render holds and the device does not is set. One the device holds and the render does not is deleted at the shortest path that holds nothing the render wants, so a removed port goes as a whole and a changed value goes alone. A hidden value ends a path by its name alone; a hidden name in a list, such as a community, stays `<redacted>` and the session names each entry when it sends the plan. A statement the device holds deactivated is activated when the render wants it.
- *
- * A policy, a filter or an import or export chain is ordered, so when anything in one changes it is deleted and set again whole, in the render's order. A path the render marks as generated, such as a prefix list `refresh` fills, keeps what the device holds.
- */
-export declare function plan(desired: string, current: string, options: Pick<ApplyOptions, "secrets">): Plan;
-export declare function login(device: Device): Promise<Client>;
-export declare function read(device: Device, _network?: readonly Device[], options?: ReadOptions): Promise<string>;
-/** How the console asks for a login. Root lands in a shell, `%`, every other user in the CLI, `>`; a session left in configuration mode, `#`, leaves it first. Not yet proved on a device. */
-export declare const JUNOS_CONSOLE: ConsoleDialect;
-/** An interactive CLI with paging off. Root lands in a shell and starts the CLI from there. */
-export declare function openCli(channel: ClientChannel): Promise<void>;
-/** How a commit that could cut access is guarded: it rolls back after `minutes` unless `prove` shows access survived. */
-export type Guard = {
-    minutes: number;
-    prove: () => Promise<void>;
-};
-/**
- * Load the plan into an exclusive candidate and check it. With a guard, commit it to roll back after `minutes`, prove access, then confirm; without one, commit it outright.
- *
- * Deletions go before the statements that are set, so a path deleted and set again in one plan ends up set.
- */
-export declare function configure(channel: ClientChannel, plan: Plan, guard?: Guard, paced?: boolean): Promise<void>;
-export declare function apply(device: Device, _network: readonly Device[], plan: Plan, options: ApplyOptions): Promise<void>;
-export declare function unsupported(device: Device): string[];
-/** The plan that replaces a prefix list's entries with what a registry returned. */
-export declare function fillPlan(set: string, prefixes: string[]): Plan;
-/** Replace a prefix list `refresh` fetched. It cannot cut access, so it is committed without a rollback. */
-export declare function fill(device: Device, _network: readonly Device[], set: string, _family: Family, prefixes: string[]): Promise<void>;
-export declare const junos: DeviceAdapter;

package/dist/types/adapters/devices/junos/render.d.ts

@@ -1,52 +0,0 @@
-import type { Device, Interface, Port, Vrrp } from "../../../schema";
-type AnyPort = Port<string, string, string, string>;
-type AnyInterface = Interface<string, string>;
-type LagInterface = Extract<AnyInterface, {
-    type: "lag";
-}>;
-type Switched = AnyPort | LagInterface;
-/** The statement each kind of public key is written under, by the key's own prefix. */
-export declare const KEY_STATEMENT: Record<string, string>;
-/** Detection under a second: three missed packets 300 ms apart. */
-export declare const BFD_INTERVAL = 300;
-/** Quote a value unless it is a plain word. Quoting more than the platform would is harmless: the comparison ignores quotes. */
-export declare function quote(value: string): string;
-/** Collects `set` statements, and comments the plan reads. */
-export declare class Statements {
-    private readonly lines;
-    private readonly notes;
-    set(...words: (string | number)[]): void;
-    note(comment: string): void;
-    /** The statements as the device prints them: each once, and none that another one extends, because the platform prints only the longest. */
-    text(): string;
-}
-/** What the platform calls a port, a LAG, a VLAN interface or a loopback. */
-export declare class Names {
-    private readonly device;
-    readonly lags: Map<string, number>;
-    readonly loopbacks: Map<string, number>;
-    readonly tunnels: Map<string, number>;
-    constructor(device: Device);
-    /** A physical port. A 10G cage holding a 1G optic is `ge-`, not `xe-`. */
-    port(port: string): string;
-    /** The physical interface a port or a LAG is: `xe-0/0/1`, `ae1`. */
-    physical(name: string): string;
-    /** The logical interface that holds addresses: `xe-0/0/1.0`, `ae1.0`, `irb.10`, `lo0.0`. */
-    unit(name: string): string;
-    /** The physical ports behind a port or a LAG. */
-    members(name: string): string[];
-}
-/** The address a VRRP group sits on: the one whose network holds the virtual address. */
-export declare function vrrpAddress(addresses: readonly string[], group: Vrrp): string | undefined;
-/**
- * The storm-control profile a port or LAG names. A profile holds one threshold for every kind it limits, so a port's kinds must share one in percent; `unsupported()` refuses any other.
- */
-export declare function stormProfile(settings: Switched): {
-    name: string;
-    percent: number;
-    left: string[];
-} | undefined;
-export declare function render(device: Device): string;
-/** The size a port's frames may reach for an IP MTU: the Ethernet header, and a VLAN tag when the port switches. */
-export declare const frameSize: (mtu: number, switched: boolean) => number;
-export {};

package/dist/types/adapters/devices/lines.d.ts

@@ -1,56 +0,0 @@
-import type { Plan } from "./types";
-export type Dialect = {
-    /** A line at the margin that opens a block, for platforms that do not indent a block's lines. */
-    block: RegExp;
-    /** Whether a block's lines are indented under it. When they are, any line followed by deeper lines opens a block. */
-    indented: boolean;
-    /** A line at the margin that closes every open block. */
-    terminator: string;
-    /** Lines that describe the device rather than configure it, or that the platform prints whatever is set. */
-    ignore: (line: string) => boolean;
-    /** The command that removes a line. */
-    undo: (line: string) => string;
-    /** Leaves one level of block. */
-    leave: string;
-    /** Lines sent before the undos of their block, because the platform refuses an undo until they are in place. */
-    first?: RegExp;
-    /** A line in the form both sides compare in, for example a secret the device prints as a cipher. */
-    canon?: (line: string) => string;
-    /** Where a block is sent among the others, lowest first, so that nothing is referenced before it exists. In the order they differ when absent. */
-    order?: (path: string[]) => number;
-};
-/** One line, with the blocks it sits in, outermost first. */
-export type Entry = {
-    path: string[];
-    line: string;
-};
-export declare function entries(text: string, dialect: Dialect): Entry[];
-/** The part of a line that names what it sets: `rule 5`, a free-text keyword, or the line up to its value. Two lines with one head are one setting with two values. */
-export declare function head(line: string): string;
-/** What changes inside one block. */
-export type Group = {
-    path: string[];
-    remove: string[];
-    add: string[];
-};
-/**
- * What differs, by block.
- *
- * A device line replaced by a desired line with the same head is not undone; sending the new one is enough. A block the render does not hold goes with its header, and its lines with it.
- */
-export declare function compare(desired: string, current: string, dialect: Dialect): Group[];
-/**
- * Replace a changed VLAN list line with only what changed.
- *
- * A platform keeps its VLANs as one line, such as `vlan batch 10 20 to 30`. Undoing the old line would delete VLANs still in use, so the plan adds the new IDs and removes the gone ones instead.
- */
-export declare function vlanListChange(groups: Group[], prefix: string, parse: (line: string) => number[], format: (ids: number[]) => string[], removal: (ids: number[]) => string[]): void;
-/** Commands a platform needs around one group, such as releasing a binding before a change and restoring it after. */
-export type Around = (group: Group) => {
-    before: string[];
-    after: string[];
-};
-/** The steps for the groups: enter each block of the path, undo, add, then leave each level. */
-export declare function steps(groups: Group[], dialect: Dialect, around?: Around): Plan["steps"];
-/** A device prints stored credentials as ciphers. They never leave the read. */
-export declare const scrub: (text: string) => string;

package/dist/types/adapters/devices/raisecom-ros/index.d.ts

@@ -1,28 +0,0 @@
-import type { ClientChannel } from "ssh2";
-import type { Device } from "../../../schema";
-import { type ConsoleDialect } from "../../../transport/console";
-import { type Dialect } from "../lines";
-import type { ApplyOptions, DeviceAdapter, Plan, ReadOptions } from "../types";
-export declare const dialect: Dialect;
-/** The access-list that guards every management service. */
-export declare const MANAGEMENT_ACL = 1000;
-/** `99,200-201,999`, the platform's compression of a VLAN list. */
-export declare function vlanList(ids: number[]): string;
-export declare function render(device: Device): string;
-/** A session, and how to prove access in a fresh login: a new SSH session, or logging out and in again on the console. */
-export type Session = {
-    channel: ClientChannel;
-    close: () => void;
-    fresh: () => Promise<Session>;
-};
-/** How the console asks for a login. Not yet proved on a device: the RAX721's console was never cabled to a jump host. */
-export declare const RAISECOM_CONSOLE: ConsoleDialect;
-/** An interactive shell, paging off, over SSH or on the console. A session that does not answer as ROS is refused, so nothing meant for it can reach another shell. */
-export declare function open(device: Device, options?: ReadOptions): Promise<Session>;
-/** What the device runs, credentials scrubbed. */
-export declare function read(device: Device, _network?: readonly Device[], options?: ReadOptions): Promise<string>;
-export declare function unsupported(device: Device): string[];
-export declare function apply(device: Device, _network: readonly Device[], plan: Plan, options: ApplyOptions): Promise<void>;
-/** The VLAN IDs of a `create vlan 10,20-30 active` line. */
-export declare function createdIds(line: string): number[];
-export declare const raisecom: DeviceAdapter;

package/dist/types/adapters/devices/routeros/export.d.ts

@@ -1,39 +0,0 @@
-export type Command = {
-    /** The menu the command belongs to, such as `/ip address`. */
-    menu: string;
-    verb: "add" | "set";
-    /** What a `set` addresses: `[ find default-name=ether1 ]`, `ftp`, `1`, or nothing for a menu of one. */
-    selector: string;
-    /** Words without a value, such as `blackhole`. */
-    flags: string[];
-    /** Properties, unquoted and unescaped. */
-    attrs: Record<string, string>;
-};
-export type Parsed = {
-    commands: Command[];
-    /** Address lists whose entries are filled by `refresh`, not by the render. */
-    generated: Set<string>;
-};
-export declare function parse(text: string): Parsed;
-/**
- * Values the platform holds when nothing was set, per menu, and under `*` for every menu.
- *
- * A property at its default is dropped from both sides of a comparison, and this is the value a property the config does not state is reset to. A property the device holds that is not here cannot be reset, which the plan reports as a problem.
- */
-export declare const DEFAULTS: Record<string, Record<string, string>>;
-/** The default of one property of a command, or undefined when it is not known. */
-export declare function defaultOf(command: Command, property: string): string | undefined;
-/** A property the device stops printing once another returns to its default. Resetting that other one clears it, so it is never reset on its own. */
-export declare const CLEARED_WITH: Record<string, Record<string, string>>;
-/** Properties whose value cannot be read back from the device. They are compared only by the presence of what holds them. */
-export declare const SECRET_KEYS: Set<string>;
-/** How the renderer writes a secret. */
-export declare const isSecretMarker: (value: string) => boolean;
-/** A command's properties without defaults or secrets, in the form both sides compare in. */
-export declare function normal(command: Command): Record<string, string>;
-/** What identifies an `add` entry, so that the same entry is found on both sides. */
-export declare function identity(command: Command): Record<string, string>;
-/** Menus whose entries are an ordered list without names. They are rewritten whole, in the order the render gives. */
-export declare const ORDERED: Set<string>;
-/** One command as a string that is equal for equal commands. */
-export declare function canonical(command: Command): string;

package/dist/types/adapters/devices/routeros/index.d.ts

@@ -1,30 +0,0 @@
-import type { Client } from "ssh2";
-import type { Device, Family } from "../../../schema";
-import { type ConsoleDialect } from "../../../transport/console";
-import type { ApplyOptions, DeviceAdapter, Plan, ReadOptions } from "../types";
-/** The major version this adapter renders for. Version 6 has a different BGP and filter language altogether. */
-export declare const SUPPORTED_MAJOR = 7;
-export declare function login(device: Device): Promise<Client>;
-/** How the RouterOS console asks for a login. The flags after the user turn off colours and terminal detection, without which the console redraws every line. */
-export declare const ROUTEROS_CONSOLE: ConsoleDialect;
-/** Where commands run, one at a time, each returning what it printed: an SSH session, or the console. */
-type Session = {
-    run(command: string, timeout?: number): Promise<string>;
-    /** Write a file to the device. Only SSH can. */
-    upload?(path: string, content: string): Promise<void>;
-    /** A fresh login, which proves access survived: this session ends and a new SSH session opens, or the console logs out and in again. */
-    fresh(): Promise<Session>;
-    end(): void;
-};
-/** Refuse a device on a version this adapter does not render for, before anything is read or sent. */
-export declare function checkVersion(session: Session, device: Device): Promise<void>;
-/**
- * What the device runs: its export, its users, and its certificates. Secrets are not part of an export.
- */
-export declare function read(device: Device, _network?: readonly Device[], options?: ReadOptions): Promise<string>;
-export declare function unsupported(device: Device): string[];
-export declare function apply(device: Device, _network: readonly Device[], changes: Plan, options: ApplyOptions): Promise<void>;
-/** Replace a list's entries in batches, so each command stays a sane length. */
-export declare function fill(device: Device, _network: readonly Device[], set: string, family: Family, prefixes: string[]): Promise<void>;
-export declare const routeros: DeviceAdapter;
-export {};

package/dist/types/adapters/devices/routeros/plan.d.ts

@@ -1,4 +0,0 @@
-import type { ApplyOptions, Plan } from "../types";
-/** A plan line the apply handles itself: upload a certificate and its key, and import them. */
-export declare const INSTALL_CERTIFICATE = "#install-certificate ";
-export declare function plan(desired: string, current: string, options: Pick<ApplyOptions, "secrets">): Plan;

package/dist/types/adapters/devices/routeros/render.d.ts

@@ -1,100 +0,0 @@
-import type { Device, Family, Interface, Port, Ports } from "../../../schema";
-/** A property value as a command takes it. `undefined` and `false` leave the property out. */
-export type Value = string | number | undefined | false;
-/** Collects commands under their menu. */
-export declare class Output {
-    private readonly menus;
-    /** Add a command to a menu. */
-    add(menu: string, command: string): void;
-    /** The whole configuration as text. */
-    text(): string;
-}
-/** Quote a value when it holds anything but plain characters. */
-export declare function quote(value: string): string;
-/**
- * A command: a verb such as `add` or `set [ find name=x ]`, then `property=value` for every property that has a value.
- *
- * Properties are written in the order given.
- */
-export declare function command(verb: string, properties: Record<string, Value>): string;
-/** `yes` or `no`. */
-export declare const yesNo: (on: boolean | undefined) => string;
-/** `V4` or `V6`, the suffix of a chain rendered for one family. */
-export declare const familySuffix: (family: Family) => string;
-/** Each port or range of ports as the platform writes it: `53`, `0-52`. */
-export declare const eachPort: (ports: Ports) => string[];
-/** One port, a range, or a list of them, as `53,0-52`. */
-export declare function portList(ports: Ports | undefined): string | undefined;
-/** Seconds as the platform writes a duration: `3600` becomes `1h`, `90` becomes `1m30s`. */
-export declare function duration(seconds: number): string;
-/** A rate as the switch chip takes it: `2G` becomes `2.0Gbps`. */
-export declare function bitrate(rate: string): string;
-/** An IPv4 prefix with a dotted mask, as the switch chip takes it: `10.0.0.0/8` becomes `10.0.0.0/255.0.0.0`. */
-export declare function dottedMask(cidr: string): string;
-/** A community pattern with `*` as a regular expression the platform matches on: `64500:*:*` becomes `^64500:[0-9]+:[0-9]+$`. */
-export declare function communityPattern(pattern: string): string;
-/** The bridge every switched port joins. One per device. */
-export declare const BRIDGE = "bridge";
-export type AnyPort = Port<string, string, string, string>;
-export type AnyInterface = Interface<string, string>;
-export declare class Context {
-    readonly device: Device;
-    readonly ports: Record<string, AnyPort>;
-    readonly interfaces: Record<string, AnyInterface>;
-    constructor(device: Device);
-    /** What the platform calls a port or an interface. A port is spelled by the model; an interface keeps its config name. */
-    name(portOrInterface: string): string;
-    /** The number of a VLAN, by its config name. */
-    vlanId(vlan: string): number;
-    /** Ports and LAGs that are layer 2 members of a VLAN, with their settings. A port in a LAG is represented by the LAG. */
-    switched(): [string, AnyPort | Extract<AnyInterface, {
-        type: "lag";
-    }>][];
-    /** VLAN interfaces, with their settings. */
-    vlanInterfaces(): [string, Extract<AnyInterface, {
-        type: "vlan";
-    }>][];
-    /** Every port and interface that holds addresses or other layer 3 settings. Ports are named as the platform spells them. */
-    routed(): {
-        name: string;
-        settings: AnyPort | AnyInterface;
-    }[];
-}
-export declare function renderInterfaces(out: Output, ctx: Context): void;
-type Speed = NonNullable<AnyPort["speed"]>;
-/** The platform's name for a fixed speed on a port, or undefined when it has none. */
-export declare function mediumOf(platformPortName: string, speed: Speed): string | undefined;
-/** The name of the VLAN interface under one with a MAC of its own, which takes the configured name itself. */
-export declare const underMacvlan: (name: string) => string;
-/** The interface holding one VRRP group. */
-export declare const vrrpName: (iface: string, id: number) => string;
-/**
- * Where LLDP runs, when it is limited to some ports. Undefined when it runs everywhere or nowhere, which the discovery settings say directly.
- */
-export declare function lldpMembers(ctx: Context): string[] | undefined;
-/** Address lists holding the prefixes BGP originates. A session reads the one of its family. */
-export declare const NETWORKS: Record<Family, string>;
-export declare function renderAddressing(out: Output, ctx: Context): void;
-export declare function renderFirewall(out: Output, ctx: Context): void;
-/** The validator group every RPKI server joins. */
-export declare const RPKI_GROUP = "rpki";
-/** The chain a session without a policy uses, so that it learns or announces nothing. */
-export declare const REJECT_ALL = "REJECT-ALL";
-export declare function renderRouting(out: Output, ctx: Context): void;
-/** Neutral service name to the platform's. `native` is the platform's own desktop client. */
-export declare const SERVICES: {
-    readonly ftp: "ftp";
-    readonly ssh: "ssh";
-    readonly telnet: "telnet";
-    readonly http: "www";
-    readonly https: "www-ssl";
-    readonly api: "api";
-    readonly api_tls: "api-ssl";
-    readonly native: "winbox";
-};
-export declare function renderManagement(out: Output, ctx: Context): void;
-/** SHA-256 of the certificate's DER encoding, lowercase hex, as the platform prints it. */
-export declare function fingerprint(pem: string): string;
-export declare function renderSystem(out: Output, ctx: Context): void;
-export declare function render(device: Device): string;
-export {};

package/dist/types/adapters/devices/types.d.ts

@@ -1,40 +0,0 @@
-import type { Device, Family } from "../../schema";
-/** One part of a plan: what a reviewer reads, and what is sent. */
-export type Step = {
-    title: string;
-    show: string[];
-    send: string[];
-};
-/** The commands that turn what a device runs into what its config says. `problems` blocks an apply: something the adapter cannot converge. */
-export type Plan = {
-    steps: Step[];
-    problems: string[];
-};
-export type ApplyOptions = {
-    /** Also send every secret, so a rotated value reaches the device. Secrets cannot be read back, so they are otherwise only sent when the object holding them is new. */
-    secrets: boolean;
-    /** Minutes before a platform that can restore itself does so, if the run does not prove access survived. */
-    rollback: number;
-    /** Reach the device through its serial console, `connection.console`, instead of SSH to its management address. */
-    console?: boolean;
-};
-/** How a device is read. */
-export type ReadOptions = Pick<ApplyOptions, "console">;
-export type DeviceAdapter = {
-    /** File extension of a saved snapshot, for syntax highlighting. */
-    extension: string;
-    /** Fields this platform cannot express. Validation fails on any of them, so nothing is skipped silently. */
-    unsupported(device: Device): string[];
-    /** The platform can be read and applied through a serial console, `--console`. */
-    console?: true;
-    /** The whole configuration the device should run. Secrets appear as markers, never values. */
-    render(device: Device): string;
-    /** What the device runs now, secrets removed, in the form `render` produces where the platform allows. */
-    read(device: Device, network: readonly Device[], options?: ReadOptions): Promise<string>;
-    /** What it takes to go from `current` to `desired`. */
-    plan(desired: string, current: string, options: ApplyOptions): Plan;
-    /** Replace the contents of a prefix set fetched from a registry. Absent on a platform that cannot hold one. */
-    fill?(device: Device, network: readonly Device[], set: string, family: Family, prefixes: string[]): Promise<void>;
-    /** Send a plan, keeping the device reachable or restoring it. */
-    apply(device: Device, network: readonly Device[], plan: Plan, options: ApplyOptions): Promise<void>;
-};

package/dist/types/adapters/devices/vrp/index.d.ts

@@ -1,27 +0,0 @@
-import type { Client, ClientChannel } from "ssh2";
-import type { Device } from "../../../schema";
-import { type ConsoleDialect } from "../../../transport/console";
-import { type Dialect } from "../lines";
-import type { ApplyOptions, DeviceAdapter, Plan, ReadOptions } from "../types";
-export declare const dialect: Dialect;
-/** The ACL that guards every management service. */
-export declare const MANAGEMENT_ACL = 2000;
-/** `99 999 to 1000 2000`, the platform's compression of a VLAN list. */
-/** The VLAN IDs of a `vlan batch` line: `vlan batch 10 20 to 30`. */
-export declare function batchIds(line: string): number[];
-export declare function vlanBatch(ids: number[]): string;
-export declare function render(device: Device): string;
-export declare function login(device: Device): Promise<Client>;
-/**
- * An interactive shell at the user prompt, paging off.
- *
- * Every login asks whether to change the password. Answering yes replaces it at once and every stored credential with it, so the answer is always no. Anything sent before the question is answered is taken as the answer.
- */
-export declare function openShell(client: Client): Promise<ClientChannel>;
-/** How the console asks for a login: the same question to change the password, always answered no, a system view left with `return`, and the line's banner after a logout or a refused password answered with Enter. Not yet proved on a device. */
-export declare const VRP_CONSOLE: ConsoleDialect;
-/** What the device runs, credentials scrubbed. */
-export declare function read(device: Device, _network?: readonly Device[], options?: ReadOptions): Promise<string>;
-export declare function unsupported(device: Device): string[];
-export declare function apply(device: Device, _network: readonly Device[], plan: Plan, options: ApplyOptions): Promise<void>;
-export declare const vrp: DeviceAdapter;

package/dist/types/adapters/registries/index.d.ts

@@ -1,3 +0,0 @@
-import type { Family } from "../../schema";
-import type { Registry } from "../../schema/policy";
-export declare const registries: Record<Registry, (query: string, family: Family) => Promise<string[]>>;

package/dist/types/adapters/registries/librenms.d.ts

@@ -1,15 +0,0 @@
-import type { Network } from "../../core/define";
-import type { Device } from "../../schema";
-/** What `librenms` would do. */
-export type LibreNmsPlan = {
-    /** Devices to add. */
-    additions: Device[];
-    /** Devices that cannot be added: their config turns SNMP off. */
-    withoutSnmp: Device[];
-    /** Hostnames LibreNMS holds that no device in the config has. */
-    unknown: string[];
-};
-/** Compare the config with what LibreNMS monitors. A device is known to LibreNMS by its management address. */
-export declare function planLibreNms(network: Network): Promise<LibreNmsPlan>;
-/** Add each device, named after its `name` and polled with the credentials from its config. */
-export declare function sendLibreNms(network: Network, additions: readonly Device[]): Promise<void>;

package/dist/types/adapters/registries/peeringdb.d.ts

@@ -1,16 +0,0 @@
-import type { Network } from "../../core/define";
-/** A change to send. `id` is set when the record exists and is updated in place. */
-export type PeeringDbChange = {
-    summary: string;
-    id?: number;
-    body: Record<string, unknown>;
-};
-export type PeeringDbPlan = {
-    changes: PeeringDbChange[];
-    /** Records PeeringDB holds that the config does not. */
-    unknown: string[];
-};
-/** What would change at PeeringDB. Reads the public API; needs no key. */
-export declare function planPeeringDb(network: Network): Promise<PeeringDbPlan>;
-/** Send the changes, with the network's API key. */
-export declare function sendPeeringDb(network: Network, changes: PeeringDbChange[]): Promise<void>;

package/dist/types/adapters/registries/prometheus.d.ts

@@ -1,16 +0,0 @@
-import type { Network } from "../../core/define";
-import type { Device } from "../../schema";
-export type PrometheusTarget = {
-    targets: string[];
-    labels: Record<string, string>;
-};
-/** The targets, and the devices left out because their config turns SNMP off. */
-export declare function prometheusTargets(network: Network): {
-    targets: PrometheusTarget[];
-    withoutSnmp: Device[];
-};
-/** The `auths` section, as YAML, and what the operator must still fill in by hand. */
-export declare function snmpExporterAuths(network: Network): {
-    yaml: string;
-    notes: string[];
-};

package/dist/types/core/across.d.ts

@@ -1,4 +0,0 @@
-import type { Device } from "../schema";
-import type { Finding } from "./define";
-/** Every rule across devices. */
-export declare function checkAcross(devices: readonly Device[]): Finding[];