@veilway/sdk 0.2.16-alpha → 0.2.19-alpha

package/dist/src/schema.d.ts

@@ -523,7 +523,7 @@ export interface components {
             /** Format: uint64 */
             throttled: number;
         };
-        /** @description A config version 1 document, see schema/config.v1.json. In an answer every secret (private_key, preshared_key, username, password) holds the marker "<redacted>", and every entry of transport_secrets holds a marker that names it, "<redacted:" with eight hex digits and ">". In a request a marker stands for the value the same object has in the running config: the inbound with that tag, the device with that public_key, the socks5 outbound with that tag and that server. A marker in transport_secrets stands for the secret of that device which it names, wherever it is in the list: an entry that is left out is removed, and a marker that names no secret of the device is an error. An outbound whose server is new or has changed needs its username and password written out. */
+        /** @description A config version 1 document, see schema/config.v1.json. In an answer every secret (private_key, preshared_key, username, password, proxy_password) holds the marker "<redacted>", and every entry of transport_secrets holds a marker that names it, "<redacted:" with eight hex digits and ">". In a request a marker stands for the value the same object has in the running config: the inbound with that tag, the device with that public_key, the socks5 outbound with that tag and that server, the user with that name (proxy_password). A marker in transport_secrets stands for the secret of that device which it names, wherever it is in the list: an entry that is left out is removed, and a marker that names no secret of the device is an error. An outbound whose server is new or has changed needs its username and password written out. */
         Document: Record<string, never>;
         /** @description The one shape of every answer that is not a success. */
         ErrorBody: {
@@ -552,6 +552,10 @@ export interface components {
             link_up: boolean | null;
             /** @description The node links of a chain backend, by tag, which `/v1/links` reports on. Empty for every other backend. */
             links: string[];
+            /** @description The `load` setting of the exit in the config. Null when the exit reports no load to apps. */
+            load: components["schemas"]["Load"] | null;
+            /** @description The level apps are told: "low", "medium" or "high". Null while the exit has no `load` setting and until the node has looked twice, which it does every 10 seconds. */
+            load_level: string | null;
             /**
              * Format: int64
              * @description Unix seconds when `latency_ms` was measured.
@@ -609,6 +613,8 @@ export interface components {
         };
         /** @description An inbound with what a client profile takes from it. No private key. */
         InboundInfo: {
+            /** @description False for an inbound the config switched off: it does not listen and takes no device. */
+            enabled: boolean;
             kind: components["schemas"]["InboundKind"];
             /** @description The WireGuard public key of the inbound. */
             public_key: components["schemas"]["Key"];
@@ -621,6 +627,8 @@ export interface components {
         InboundKind: "wireguard" | "veilway";
         /** @description One transport of an inbound, with the rating a profile of it gets. */
         InboundTransport: {
+            /** @description False for a transport the config switched off: it does not listen. */
+            enabled: boolean;
             rating: components["schemas"]["Rating"];
             transport: components["schemas"]["Transport"];
         };
@@ -691,6 +699,19 @@ export interface components {
         Links: {
             links: components["schemas"]["Link"][];
         };
+        /** @description Apps show a user how busy an exit is in three coarse levels: below `busy` is low, from `busy` is medium, from `very_busy` is high. The node looks every 10 seconds and changes the level once the new one held for two looks in a row. */
+        Load: {
+            /** Format: uint32 */
+            busy: number;
+            by: components["schemas"]["LoadBy"];
+            /**
+             * Format: uint32
+             * @description Greater than `busy`.
+             */
+            very_busy: number;
+        };
+        /** @description What `Load::by` measures. */
+        LoadBy: "flows" | "mbps";
         /**
          * @description The counters of one outbound: those of the exits that leave through it, added up, with what the node knows of its proxy.
          *     The node learns whether a proxy relays UDP once for each exit, from the flows of that exit, so two exits through one proxy can know different things for a while. This is what they know together.
@@ -698,6 +719,8 @@ export interface components {
         OutboundStats: {
             /** Format: uint64 */
             down_bytes_per_sec: number;
+            /** @description Why an `xray` outbound cannot carry a flow now, in words: the add-on is not installed or not running, Xray ended and starts again, or the name of its server does not resolve to an address the node may dial. Every exit through it is down with the same reason. Null while it carries, and for an outbound that is not `xray`. */
+            down_reason: string | null;
             /**
              * Format: uint64
              * @description How long the proxy took to answer the greeting of the last flow that dialled it, in milliseconds. Null for a direct outbound, and until a flow has used the proxy. A reload starts it over.
@@ -735,6 +758,46 @@ export interface components {
             message: string;
             path: string;
         };
+        /** @description What one proxy inbound counted since it started. Everything but `open` only grows. */
+        ProxyStats: {
+            /** Format: uint64 */
+            down_bytes: number;
+            /** @description The tag of the inbound. */
+            name: string;
+            /** Format: uint */
+            open: number;
+            /**
+             * Format: uint64
+             * @description Connections the inbound took, and those open right now.
+             */
+            opened: number;
+            /** Format: uint64 */
+            refused_blocked: number;
+            /** Format: uint64 */
+            refused_busy: number;
+            /**
+             * Format: uint64
+             * @description Connections turned away at the inbound's `connections`, at a source's `per_source` and at `handshakes`, and logins refused unheard because a source had failed too many to that name.
+             */
+            refused_limit: number;
+            /**
+             * Format: uint64
+             * @description Logins that were refused: no such user, a wrong password, a user the inbound does not admit.
+             */
+            refused_logins: number;
+            /** Format: uint64 */
+            refused_source: number;
+            /**
+             * Format: uint64
+             * @description UDP datagrams dropped because they did not come from the address and port the client named for its association, which is what a client behind a NAT that rewrites ports is refused for.
+             */
+            refused_udp_source: number;
+            /**
+             * Format: uint64
+             * @description Bytes the clients sent to their destinations and got back.
+             */
+            up_bytes: number;
+        };
         /** @enum {string} */
         QuotaPeriod: "daily" | "weekly" | "monthly";
         /** @description The counters of one user, inbound or exit, with how fast they grew over the last seconds. */
@@ -898,6 +961,8 @@ export interface components {
             inbounds: components["schemas"]["Rated"][];
             /** @description Every outbound of the running config, in its order. An exit with an `l3` or `block` backend has no outbound and is in none of them. */
             outbounds: components["schemas"]["OutboundStats"][];
+            /** @description Every proxy inbound (`socks5`, `http`, `mixed`) that runs, in the order of the config. An inbound that a reload changed starts counting over. Its bytes are in `inbounds` as well. */
+            proxies: components["schemas"]["ProxyStats"][];
             /** @description The replay memory of the obfuscated transports. Null for a node that never ran one, which keeps no replay memory. */
             replay: components["schemas"]["Replay"] | null;
             /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@veilway/sdk",
-	"version": "0.2.16-alpha",
+	"version": "0.2.19-alpha",
 	"description": "Typed client for the Veilway control API",
 	"license": "Apache-2.0",
 	"repository": {