@takodotid/circuit 0.43.1 → 1.0.0-rc.2

package/dist/types/schema/policy.d.ts

@@ -1,107 +0,0 @@
-import type { Family, IP, Prefix } from "./common.js";
-/** A standard BGP community, `asn:value`, for example `64500:100`. Each part is 0 to 65535. */
-export type StandardCommunity = `${number}:${number}`;
-/** A large BGP community, `asn:function:parameter`, for example `64500:1:6939`. Each part is 0 to 4294967295. */
-export type LargeCommunity = `${number}:${number}:${number}`;
-/** A standard community to remove. `*` stands for any value of a part, as in `64500:*`. */
-export type StandardCommunityPattern = `${number | "*"}:${number | "*"}`;
-/** A large community to remove. `*` stands for any value of a part, as in `64500:*:*`. */
-export type LargeCommunityPattern = `${number | "*"}:${number | "*"}:${number | "*"}`;
-/** Registries a prefix set can be fetched from. */
-export type Registry = "ripe-stat";
-/** Prefixes listed here, or fetched from a registry by `refresh` and never typed by hand. */
-export type PrefixSet = {
-    /** The prefixes, of one family. */
-    prefixes: readonly Prefix[];
-} | {
-    source: {
-        /** Where the prefixes come from. */
-        registry: Registry;
-        /** What to ask for, for example `AS7713`. */
-        query: string;
-        /** Which family to keep. */
-        family: Family;
-    };
-};
-/** Conditions on a route. All must be true. An empty match is true for every route. */
-export type Match<S extends string> = {
-    /** Only routes of this family. */
-    family?: Family;
-    /** Exactly this prefix. */
-    prefix?: Prefix;
-    /** Any prefix in this set. */
-    prefix_set?: S;
-    /** Prefix length within this range, inclusive. */
-    prefix_length?: {
-        min?: number;
-        max?: number;
-    };
-    /** AS path length within this range, inclusive. Every AS counts, prepends included. */
-    as_path_length?: {
-        min?: number;
-        max?: number;
-    };
-    /** The AS path holds this AS anywhere: the route came from it or through it. */
-    through_as?: number;
-    /** The route's origin validation state. */
-    rpki?: "valid" | "invalid" | "not-found";
-    /** Has this standard community, `asn:value`. */
-    community?: StandardCommunity;
-    /** Has this large community, `asn:function:parameter`. */
-    large_community?: LargeCommunity;
-};
-/** Changes to a route. In community lists to remove, `*` stands for any value of a field, as in `64500:*:*`. */
-export type Sets = {
-    /** Preference among routes to the same prefix within our AS. Higher wins. */
-    local_pref?: number;
-    /** Multi-exit discriminator offered to the neighbor. Lower wins. */
-    med?: number;
-    /** Prepend our own AS this many times, to make the path look longer. */
-    prepend?: number;
-    /** Replace the route's standard communities with these. */
-    communities?: readonly StandardCommunity[];
-    /** Add these standard communities. */
-    add_communities?: readonly StandardCommunity[];
-    /** Remove standard communities matching these. A part may be `*`. */
-    remove_communities?: readonly StandardCommunityPattern[];
-    /** Replace the route's large communities with these. */
-    large_communities?: readonly LargeCommunity[];
-    /** Add these large communities. */
-    add_large_communities?: readonly LargeCommunity[];
-    /** Remove large communities matching these. A part may be `*`. */
-    remove_large_communities?: readonly LargeCommunityPattern[];
-    /** Next hop for the route. */
-    next_hop?: IP;
-    /** Source address for traffic the device itself sends to the route. Applies to routes of the same family as the address. */
-    preferred_source?: IP;
-    /** Drop traffic to the route on this device, instead of forwarding it. */
-    blackhole?: true;
-};
-/**
- * Run another policy at this point. A route it accepts or rejects stops there; any other route goes on to the next rule. A call holds nothing else: to call a policy for some routes only, put the match inside that policy.
- */
-export type CallRule<P extends string> = {
-    /** Shown beside the rule on the device. */
-    description?: string;
-    /** The policy to run. */
-    call: P;
-    match?: never;
-    set?: never;
-    action?: never;
-};
-/** Change and decide on the routes that match. A rule without `action` changes the route and moves on to the next rule. */
-export type MatchRule<S extends string> = {
-    /** Shown beside the rule on the device. */
-    description?: string;
-    call?: never;
-    /** Which routes the rule applies to. Every route when absent. */
-    match?: Match<S>;
-    /** What to change on a matching route. */
-    set?: Sets;
-    /** Accept or reject a matching route, ending the policy for it. */
-    action?: "accept" | "reject";
-};
-/** One step of a route policy: a call to another policy, or a rule that matches routes, changes them and may decide on them. */
-export type PolicyRule<P extends string, S extends string> = CallRule<P> | MatchRule<S>;
-/** Rules evaluated in order, first decision wins. A route no rule accepts is rejected. */
-export type RoutePolicy<P extends string, S extends string> = readonly PolicyRule<P, S>[];

package/dist/types/schema/routing.d.ts

@@ -1,161 +0,0 @@
-import type { Family, IP, Prefix, Secret } from "./common.js";
-/** A route the device has without learning it. */
-export type StaticRoute<I extends string, F extends string, T extends string = never> = {
-    /** Destination. */
-    prefix: Prefix;
-    /** Next-hop address. */
-    via?: IP;
-    /** Next-hop interface, for a link without a next-hop address. */
-    interface?: I;
-    /** Discard matching traffic. The usual way to originate an aggregate. */
-    blackhole?: true;
-    /** Withdraw the route while BFD finds `via` dead, and put it back once `via` answers again. Needs `via`. */
-    bfd?: true;
-    /** Preference against other routes to the same prefix. Lower wins. 1 when absent. */
-    distance?: number;
-    /** The VRF the route is in. The main table when absent. */
-    vrf?: F;
-    /** The table the route is in: `main`, or one of `routing.tables`. The main table when absent; write `main` to say so. A route has a `vrf` or a `table`, not both. */
-    table?: T | "main";
-    /** Why the route exists. */
-    description?: string;
-};
-/**
- * What a BGP neighbor is to us, with the roles RFC 9234 defines: `provider`, a transit we buy from; `customer`, one we sell transit to; `peer`, one we exchange our own routes with; `rs`, an exchange's route server; `rs-client`, a network using our route server.
- */
-export type BgpRole = "provider" | "customer" | "peer" | "rs" | "rs-client";
-/** Settings a BGP neighbor can set itself or take from its group. */
-export type NeighborSettings<P extends string, T extends string = never> = {
-    /** The neighbor's AS. Our own AS makes the session internal. */
-    remote_as?: number;
-    /** Who the neighbor is. */
-    description?: string;
-    /** Source address for the session. The outgoing interface's address when absent. */
-    local_address?: IP;
-    /** Policy for routes learned. Nothing is accepted when absent. */
-    import?: P;
-    /** Policy for routes announced. Nothing is announced when absent. */
-    export?: P;
-    /** What the neighbor is to us, such as `provider` for a transit. Both sides then reject a route leak, as RFC 9234 describes. */
-    role?: BgpRole;
-    /** The neighbor is more than one hop away. */
-    multihop?: boolean;
-    /** TCP MD5 password shared with the neighbor. */
-    password?: Secret;
-    /** Close the session when the neighbor announces more prefixes than this. It stays closed until cleared by hand, on RouterOS with `/routing bgp session clear <session> flag=limit-exceeded`. */
-    max_prefixes?: number;
-    /** Seconds without a message before the session is declared down. */
-    hold_time?: number;
-    /** Seconds between keepalive messages. */
-    keepalive?: number;
-    /** Families exchanged. The family of the neighbor's address when absent. */
-    families?: readonly Family[];
-    /** Wait for the neighbor to connect instead of connecting to it. */
-    passive?: boolean;
-    /** Detect a dead link in under a second with BFD. */
-    bfd?: boolean;
-    /** The table the routes learned are installed in: `main`, or one of `routing.tables`. The main table when absent; write `main` to say so. On RouterOS the session also announces from that table, so each prefix of `networks` it announces needs a route in the table too, and a running session takes a new table only when it restarts. */
-    table?: T | "main";
-};
-/** One BGP session. Settings it does not set come from its group. */
-export type Neighbor<P extends string, G extends string, T extends string = never> = NeighborSettings<P, T> & {
-    /** The neighbor's address. */
-    address: IP;
-    /** The group this neighbor takes a setting from when it does not set that setting itself. */
-    group?: NoInfer<G>;
-};
-/** BGP on this device. */
-export type Bgp<P extends string, G extends string, T extends string = never> = {
-    /** Our AS number. */
-    asn: number;
-    /** Prefixes this device originates. Each needs a route, for example a static blackhole. Export policy still decides who receives them. */
-    networks?: readonly Prefix[];
-    /** Settings shared by several neighbors, keyed by group name. */
-    groups?: Record<G, NeighborSettings<P, T>>;
-    /** Sessions keyed by name. */
-    neighbors?: Record<string, Neighbor<P, G, T>>;
-};
-/** How fast BFD notices a dead neighbor: after `multiplier` packets in a row are missed, so in `interval` times `multiplier` milliseconds. */
-export type Bfd = {
-    /** Milliseconds between the packets this device sends, and the shortest gap it asks of the neighbor. */
-    interval: number;
-    /** How many packets in a row may be missed before the neighbor is declared down. */
-    multiplier: number;
-};
-/** A route origin validation server, RFC 8210. */
-export type RpkiServer = {
-    /** Where the validator listens. */
-    address: IP;
-    /** Its RTR port, often 323 or 8282. */
-    port: number;
-    /** Who runs it, or why it is here. */
-    description?: string;
-};
-/** OSPF on one interface. */
-export type OspfInterface = {
-    /** Cost of sending through this interface. Lower is preferred. Derived from speed when absent. */
-    cost?: number;
-    /** Advertise the interface's network but form no adjacency on it. */
-    passive?: boolean;
-    /** How the link is treated. Broadcast when absent. */
-    network?: "broadcast" | "point-to-point";
-    /** Detect a dead neighbor in under a second with BFD. */
-    bfd?: boolean;
-};
-/** An OSPF area ID, written as four numbers with dots between them, for example `0.0.0.0` for the backbone. */
-export type OspfAreaId = `${number}.${number}.${number}.${number}`;
-/** OSPF, version 2 for IPv4 and version 3 for IPv6. */
-export type Ospf<I extends string> = {
-    /** Which versions run. IPv4 when absent. */
-    families?: readonly Family[];
-    /** Areas keyed by area ID, for example `0.0.0.0`, each with the interfaces in it. */
-    areas: Record<OspfAreaId, {
-        interfaces: Partial<Record<I, OspfInterface>>;
-    }>;
-    /** Routes from other sources announced into OSPF. */
-    redistribute?: readonly ("connected" | "static")[];
-};
-/** A routing table beside the main one. It holds no interfaces: routes go in from static routes and BGP neighbors that name it in `table`, and `routing.rules` send traffic to it. */
-export type RoutingTable = {
-    /** What the table is for. */
-    description?: string;
-};
-/** Traffic a routing rule matches: all of what is given. Every packet when absent. */
-export type RoutingRuleMatch<I extends string> = {
-    /** Source prefix. */
-    src?: Prefix;
-    /** Destination prefix. */
-    dst?: Prefix;
-    /** The interface the traffic arrives on. */
-    in_interface?: I;
-};
-/** One routing rule: traffic it matches is routed by `table` instead of the main table. */
-export type RoutingRule<I extends string, T extends string> = {
-    /** Why the rule exists. */
-    description?: string;
-    /** What the traffic must match. Every packet when absent, so such a rule is the last one. */
-    match?: RoutingRuleMatch<I>;
-    /** The table that routes the traffic: one of `routing.tables`, or `main`. */
-    table: T | "main";
-    /** When `table` has no route for a packet: `none` drops it as unroutable, `main` routes it by the main table instead. `none` when absent. Not for a rule whose table is `main`. */
-    fallback?: "none" | "main";
-};
-/** Routing on this device. */
-export type Routing<P extends string, G extends string, I extends string, F extends string, T extends string = never> = {
-    /** Identifies this router to its neighbors. */
-    router_id?: IP;
-    /** Routing tables beside the main one, keyed by name. Not `main`, and not the name of a VRF. */
-    tables?: Record<T, RoutingTable>;
-    /** Rules that route matching traffic by another table, such as traffic from one block by its own transits' default. In order: the first that matches decides, and traffic no rule matches is routed by the main table. */
-    rules?: readonly RoutingRule<I, NoInfer<T>>[];
-    /** Routes the device has without learning them. */
-    static?: readonly StaticRoute<I, F, NoInfer<T>>[];
-    /** BGP sessions and what they exchange. */
-    bgp?: Bgp<P, G, NoInfer<T>>;
-    /** OSPF areas and interfaces. */
-    ospf?: Ospf<I>;
-    /** Validators answering route origin validation. */
-    rpki?: readonly RpkiServer[];
-    /** BFD timers for every BFD session on the device: BGP, OSPF and static routes. The platform's own when absent; Junos has none, so Circuit sends every 300 ms there. Both ends of a link should agree. */
-    bfd?: Bfd;
-};

package/dist/types/schema/system.d.ts

@@ -1,198 +0,0 @@
-import type { IP, MacAddress, Prefix, Secret, Severity } from "./common.js";
-import type { TimeZone } from "./time-zones.js";
-/** A software release track, as RouterOS names them. `long-term` changes least; `development` is the newest and least tested. */
-export type ReleaseChannel = "long-term" | "stable" | "testing" | "development";
-/** How bad an alarm is, most severe first, as ITU-T X.733 ranks them. */
-export type AlarmSeverity = "critical" | "major" | "minor" | "warning";
-/** Device-wide settings. */
-export type System = {
-    /** IANA zone, for example `Asia/Jakarta`. The editor suggests every name. UTC when absent. */
-    timezone?: TimeZone;
-    /** Shown at login. */
-    banner?: string;
-    /** Resolvers the device uses. */
-    dns?: {
-        /** Resolvers, in order of preference. */
-        servers: readonly IP[];
-        /** Answer queries from others. Off when absent. */
-        serve?: boolean;
-    };
-    /** How the device keeps time. */
-    ntp?: {
-        /** Time sources, by address or name. */
-        servers: readonly string[];
-        /** Answer time queries from others. Off when absent. */
-        serve?: boolean;
-    };
-    /** Where log messages go. */
-    logging?: {
-        /** Kept on the device's own storage, from `level` up. */
-        local?: {
-            /** The least severe message kept. */
-            level: Severity;
-            /** How many rotated files to keep. */
-            files?: number;
-            /** Lines in each file before it rotates. */
-            lines_per_file?: number;
-        };
-        /** Sent to syslog collectors, each from its own `level` up. */
-        remote?: readonly {
-            address: IP;
-            /** UDP port. 514 when absent. */
-            port?: number;
-            /** The least severe message sent. */
-            level: Severity;
-        }[];
-    };
-    /** Software release track the device updates from. `stable` when absent. */
-    release_channel?: ReleaseChannel;
-    /** Alarms raised at another severity than the platform's own, keyed by the alarm's name as the platform spells it, such as `hwOpticalUnAuthorized` on VRP. */
-    alarms?: Record<string, {
-        severity: AlarmSeverity;
-    }>;
-    /** Read optic temperature, power and voltage. */
-    transceiver_monitoring?: boolean;
-    /** Host behaviour of the IP stack. */
-    ip?: {
-        /** Send ICMP redirects. Off when absent. */
-        icmp_redirects?: boolean;
-        /** Answer a TCP SYN flood with SYN cookies. Off when absent. */
-        syn_cookies?: boolean;
-    };
-};
-/** A login on the device. */
-export type User = {
-    /** What the user may do. */
-    role: "admin" | "operator" | "read-only";
-    /** The login password. */
-    password: Secret;
-    /** Who the account is for. */
-    description?: string;
-    /** Public keys accepted instead of the password over SSH. */
-    ssh_keys?: readonly string[];
-};
-/** A way into the device. Absent means turned off. */
-export type Service = {
-    /** Sources allowed. `management.allow` when absent. */
-    allow?: readonly Prefix[];
-    /** TCP or UDP port. The protocol's own when absent. */
-    port?: number;
-};
-/** One SNMPv3 user. */
-export type SnmpUser = {
-    /** How messages are authenticated. */
-    auth: "sha1" | "sha256";
-    /** The authentication passphrase. */
-    auth_password: Secret;
-    /** How messages are encrypted. */
-    privacy: "aes128" | "des";
-    /** The encryption passphrase. */
-    privacy_password: Secret;
-};
-/** How the device is reached and managed. */
-export type Management<I extends string, C extends string> = {
-    /** Sources allowed to every service that does not set its own. */
-    allow?: readonly Prefix[];
-    /** The ports and interfaces the services answer on; every other one answers ping alone. Every one with an address when absent. */
-    interfaces?: readonly I[];
-    /** Secure shell. */
-    ssh?: Service & {
-        /** Also offer legacy ciphers, MACs and key exchanges. Off when absent. */
-        weak_crypto?: boolean;
-        /** Seconds a login may take. */
-        auth_timeout?: number;
-        /** Failed attempts allowed per connection. */
-        auth_retries?: number;
-    };
-    /** Unencrypted remote login. */
-    telnet?: Service;
-    /** Web interface, unencrypted. */
-    http?: Service;
-    /** Web interface over TLS. */
-    https?: Service & {
-        /** One of the device's `certificates`. */
-        certificate?: C;
-    };
-    /** The platform's own API, unencrypted. */
-    api?: Service;
-    /** The platform's own API over TLS. */
-    api_tls?: Service & {
-        /** One of the device's `certificates`. */
-        certificate?: C;
-    };
-    /** File transfer, unencrypted. */
-    ftp?: Service;
-    /** The platform's own management protocol. `interfaces` also allows it at layer 2 on those interfaces. */
-    native?: Service & {
-        interfaces?: readonly I[];
-    };
-    /** Polling by SNMP. */
-    snmp?: Service & {
-        /** Read-only community for version 2c. Version 2c is off when absent. */
-        community?: Secret;
-        /** Version 3 users, keyed by name. */
-        users?: Record<string, SnmpUser>;
-        /** Who to contact about the device. */
-        contact?: string;
-        /** Where the device is. */
-        location?: string;
-    };
-    /** Console login uses this password. The device's users when absent. */
-    console?: {
-        password: Secret;
-    };
-    /** Password for privileged mode, on platforms that have one. */
-    privilege_password?: Secret;
-};
-/** A DHCP server for one network. */
-export type DhcpServer<I extends string> = {
-    /** Where it answers. */
-    interface: I;
-    /** The network it serves. */
-    network: Prefix;
-    /** Default gateway given to clients. */
-    gateway: IP;
-    /** Resolvers given to clients. */
-    dns?: readonly IP[];
-    /** First and last address given to clients. */
-    pool: readonly [IP, IP];
-    /** Seconds a lease lasts. */
-    lease_time?: number;
-    /** Addresses fixed to a MAC. */
-    reservations?: readonly {
-        address: IP;
-        /** The client's MAC address. */
-        mac: MacAddress;
-        /** Whose address it is. */
-        description?: string;
-    }[];
-};
-/** Forward DHCP requests heard on an interface to servers elsewhere. */
-export type DhcpRelay<I extends string> = {
-    /** Where requests are heard. */
-    interface: I;
-    /** Where they are forwarded. */
-    servers: readonly IP[];
-};
-/** A certificate the device presents or trusts. */
-export type Certificate = {
-    /** The certificate, PEM. Public, so it is kept in the repository. */
-    certificate: string;
-    /** Its private key: a PEM file through `secretFile`, or PEM base64-encoded as one line through `secret`. A certificate the device only trusts, such as a CA, has none. */
-    private_key?: Secret;
-};
-/** Export flow records or packet samples to collectors. */
-export type FlowExport<I extends string> = {
-    /** The record format. */
-    protocol: "sflow" | "netflow-v9" | "ipfix";
-    /** Where records are sent. */
-    collectors: readonly {
-        address: IP;
-        /** UDP port. 6343 for sFlow and 2055 otherwise when absent. */
-        port?: number;
-    }[];
-    /** Sample one packet in this many. Every packet when absent, on a platform that can export every packet. */
-    sampling?: number;
-    /** Where traffic is observed. Every interface when absent. */
-    interfaces?: readonly I[];
-};

package/dist/types/schema/time-zones.d.ts

@@ -1,2 +0,0 @@
-/** An IANA time zone name, such as `Asia/Jakarta`, or `UTC`. */
-export type TimeZone = "UTC" | "Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmara" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/Buenos_Aires" | "America/Argentina/Catamarca" | "America/Argentina/Cordoba" | "America/Argentina/Jujuy" | "America/Argentina/La_Rioja" | "America/Argentina/Mendoza" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Atikokan" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Fort_Nelson" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Indianapolis" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Louisville" | "America/Kentucky/Monticello" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Nuuk" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Chongqing" | "Asia/Colombo" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Hebron" | "Asia/Ho_Chi_Minh" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kathmandu" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ulaanbaatar" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yangon" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Faroe" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Canberra" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/Perth" | "Australia/Sydney" | "Etc/GMT" | "Etc/GMT+1" | "Etc/GMT+10" | "Etc/GMT+11" | "Etc/GMT+12" | "Etc/GMT+2" | "Etc/GMT+3" | "Etc/GMT+4" | "Etc/GMT+5" | "Etc/GMT+6" | "Etc/GMT+7" | "Etc/GMT+8" | "Etc/GMT+9" | "Etc/GMT-1" | "Etc/GMT-10" | "Etc/GMT-11" | "Etc/GMT-12" | "Etc/GMT-13" | "Etc/GMT-14" | "Etc/GMT-2" | "Etc/GMT-3" | "Etc/GMT-4" | "Etc/GMT-5" | "Etc/GMT-6" | "Etc/GMT-7" | "Etc/GMT-8" | "Etc/GMT-9" | "Etc/UTC" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Kyiv" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Chuuk" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kanton" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Pohnpei" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis";

package/dist/types/transport/console.d.ts

@@ -1,115 +0,0 @@
-import { type ClientChannel } from "ssh2";
-import type { Console, Device } from "../schema/index.js";
-/** An open console: the stream to the device's CLI, and how to let it go. `close` waits for the console to go quiet, then lets the port go. */
-export type ConsoleSession = {
-    channel: ClientChannel;
-    close: () => Promise<void>;
-};
-/** How a platform's console asks for a login and shows its prompt, and what moves it on from anywhere else. */
-export type ConsoleDialect = {
-    /** The login prompt. */
-    login: RegExp;
-    /** The password prompt. */
-    password: RegExp;
-    /** The CLI's prompt once logged in. */
-    prompt: RegExp;
-    /** What logs out from the prompt. */
-    logout: string;
-    /** Other places a console can be left, each with what moves it toward a login prompt: a pager, a config level, a question. Checked before the prompt. */
-    others?: readonly (readonly [RegExp, string])[];
-    /** The name typed at the login prompt, when the platform adds to it. */
-    user?: (user: string) => string;
-    /** What the console prints when it refuses a password, for a console that then shows no login prompt. */
-    refused?: RegExp;
-};
-/** The channel a console speaks on: an SSH stream from the relay, or anything shaped like one. */
-type Channel = Pick<ClientChannel, "write"> & {
-    on(event: "data", listener: (chunk: Buffer) => void): unknown;
-    removeListener(event: "data", listener: (chunk: Buffer) => void): unknown;
-};
-export declare class SerialConsole {
-    private static readonly RELAY_PATH;
-    /** A serial port the relay is started with: a path under /dev, which reaches a shell, or a Windows COM port. */
-    private static readonly PORT;
-    private static readonly WINDOWS_PORT;
-    /** Terminal escape sequences: cursor moves, screen clears, character sets and modes. */
-    private static readonly ESCAPES;
-    /** A session to a jump host, through `cloudflared access ssh` when it sits behind a Cloudflare Tunnel. */
-    private static connectJump;
-    /**
-     * Open a device's serial console, through its jump host or on this computer.
-     *
-     * A port another program holds is tried again every five seconds, `attempts` times in all, then fails with a message that starts with `busy:`.
-     */
-    static open(console: Console, attempts?: number): Promise<ConsoleSession>;
-    private static openOnJump;
-    /** The relay as a child process: Python on Linux and macOS, PowerShell on Windows. */
-    private static openHere;
-    /** Wait until the relay says it holds the port, or why it cannot. */
-    private static relayReady;
-    /** A terminal ends a line with a carriage return. Adapters write lines as they do over SSH, and the console gets what a keyboard would send. */
-    private static asTerminal;
-    /** A device's console and its login, for `--console`. */
-    static of(device: Device): {
-        console: Console;
-        user: string;
-        password: string;
-    };
-    /**
-     * Write, then wait until what the console printed since ends with one of the patterns. Returns which, and what was printed.
-     *
-     * With `settle`, a match counts only once nothing more arrives for that many milliseconds, so a line in the middle of the output that looks like a prompt does not end it.
-     */
-    static expect(channel: Channel, write: string, patterns: readonly RegExp[], timeout?: number, settle?: number): Promise<{
-        index: number;
-        text: string;
-    }>;
-    /**
-     * Log in on a console, whatever state the last session left it in: what `others` names is moved on, a session left open is logged out, so every session starts from a fresh login. Returns once the CLI's prompt shows. A console that asks only for a password (`passwordOnly`) is logged in at its password prompt, with no name typed.
-     */
-    static login(channel: Channel, dialect: ConsoleDialect, user: string, password: string, passwordOnly?: boolean): Promise<void>;
-    /** Wait until the console has printed nothing for `silence` milliseconds, dropping what it printed, at most five seconds. */
-    private static quiet;
-    /** Write, then collect what the console prints until it is quiet for `silence` milliseconds, or for `limit` in all. Carriage returns and escape sequences are dropped. */
-    static listen(channel: Channel, write: string, silence: number, limit?: number): Promise<string>;
-    /** The text after a command's echo. A terminal wraps a long echo where it likes, so the echo is matched character by character, line breaks it added skipped. */
-    static afterEcho(text: string, command: string): string;
-    /** Where the echo of a command that starts at `start` ends, or undefined when the text there is not its echo. */
-    private static echoEnd;
-}
-/** A CLI on a console or in an SSH shell that runs one command at a time and returns what it printed, as an SSH exec would: no echo, no prompt. */
-export declare class ConsoleShell {
-    private readonly channel;
-    private readonly dialect;
-    /** Milliseconds of quiet after the prompt shows before a command counts as done. */
-    private readonly settle;
-    /** The quiet to wait for after the prompt when output can hold a line that looks like it, as `circuit show` prints whatever the device has. */
-    static readonly SETTLE = 1000;
-    constructor(channel: Channel, dialect: ConsoleDialect, 
-    /** Milliseconds of quiet after the prompt shows before a command counts as done. */
-    settle?: number);
-    /** Run a command and wait for the prompt. A pager in `others` is answered as it shows. */
-    run(command: string, timeout?: number): Promise<string>;
-    /** Log out, so no session is left open on the console. */
-    logout(): void;
-}
-/** One line for `circuit console`: what to send, the quiet that ends its answer, and the text the last answer must end with for the line to be sent. */
-export type ScriptLine = {
-    text: string;
-    quiet: number;
-    onlyAfter?: string;
-};
-/**
- * Lines sent to a console one at a time, each answer read until the console goes quiet, as a person would type them.
- *
- * A line may start with `@if=TEXT=>`: it is sent only when the last answer ends with TEXT, for a prompt that may or may not come. Then, or alone, `@wait=N:` waits for N seconds of quiet instead of the usual 1.5, for a slow command.
- */
-export declare class ConsoleScript {
-    /** The quiet that ends an answer, in milliseconds. */
-    static readonly QUIET = 1500;
-    /** A line as written, with `quiet` for a line that has no `@wait=`. */
-    static parse(line: string, quiet?: number): ScriptLine;
-    /** Send each line and hand each answer to `answered` as it comes. A line whose condition does not hold is skipped. */
-    static run(channel: Channel, lines: readonly string[], answered: (answer: string) => void, quiet?: number): Promise<void>;
-}
-export {};

package/dist/types/transport/path-check.d.ts

@@ -1,32 +0,0 @@
-/** What the pings found: how many were sent, and the round trip of each that came back, in milliseconds. */
-export type PathMeasure = {
-    sent: number;
-    times: number[];
-};
-/** Whether an apply may go ahead over the path, and a line that says why. */
-export type PathVerdict = {
-    refuse: boolean;
-    summary: string;
-};
-export declare class PathCheck {
-    /** Pings sent in all. With 20, one lost is 5%. */
-    static readonly PINGS = 20;
-    /** Ping programs run side by side, so the check takes about five seconds on every system: each sends one ping a second. */
-    private static readonly RUNS;
-    /** The most loss allowed, in percent: one of 20 pings may be lost, two may not. */
-    static readonly MAX_LOSS_PERCENT = 5;
-    /** The highest average round trip allowed, in milliseconds. */
-    static readonly MAX_AVERAGE_MS = 300;
-    /** How long one ping program may run before it is stopped and what it printed is counted. */
-    private static readonly LIMIT_MS;
-    /**
-     * The round trip of every reply in what `ping` printed, in milliseconds. A reply is the one line with a time after `=` or `<` and before `ms`, as in `time=12 ms` or `time<1ms`: the same in every language `ping` prints in. A summary line has several times, or none right before `ms`, and is not counted.
-     */
-    static parse(output: string): number[];
-    /** Whether the path is good enough to apply over. A device that answers no ping at all may only block it, so that alone is not refused. */
-    static verdict(host: string, measure: PathMeasure): PathVerdict;
-    /** Ping a host with the system's `ping`. Undefined when there is no `ping` to run. */
-    static measure(host: string): Promise<PathMeasure | undefined>;
-    /** What one run of `ping` printed. Windows takes `-n` and a wait per ping in milliseconds; Linux and macOS take `-c`, and macOS pings IPv6 with `ping6`. */
-    private static ping;
-}