@frp-bridge/types 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 imba97 <https://github.com/imba97>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.mts

@@ -0,0 +1,527 @@
+/**
+ * FRP 通用配置类型定义
+ * 基于 frp 官方文档: https://gofrp.org/zh-cn/docs/reference/common/
+ */
+/** 日志级别类型 */
+type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error';
+/** 日志配置 */
+interface LogConfig {
+    /** 日志输出文件路径，如果为 console，则会将日志打印在标准输出中 */
+    to?: string;
+    /** 日志级别，可选值为 trace, debug, info, warn, error，默认级别为 info */
+    level?: LogLevel;
+    /** 日志文件最多保留天数，默认为 3 天 */
+    maxDays?: number;
+    /** 禁用标准输出中的日志颜色 */
+    disablePrintColor?: boolean;
+}
+/** TLS 配置 */
+interface TLSConfig {
+    /** TLS 证书文件路径 */
+    certFile: string;
+    /** TLS 密钥文件路径 */
+    keyFile: string;
+    /** CA 证书文件路径 */
+    trustedCaFile?: string;
+    /** TLS Server 名称 */
+    serverName?: string;
+}
+/** Web 服务器配置 */
+interface WebServerConfig {
+    /** webServer 监听地址，默认为 127.0.0.1 */
+    addr?: string;
+    /** webServer 监听端口 */
+    port: number;
+    /** HTTP BasicAuth 用户名 */
+    user?: string;
+    /** HTTP BasicAuth 密码 */
+    password?: string;
+    /** 静态资源目录，Dashboard 使用的资源默认打包在二进制文件中，通过指定此参数使用自定义的静态资源 */
+    assetsDir?: string;
+    /** 启动 Go HTTP pprof，用于应用调试 */
+    pprofEnable?: boolean;
+    /** Dashboard 启用 HTTPS 的 TLS 相关配置 */
+    tls?: TLSConfig;
+}
+/** QUIC 协议选项 */
+interface QUICOptions {
+    /** 保活周期，默认值为 10 秒 */
+    keepalivePeriod?: number;
+    /** 最大空闲超时时间，默认值为 30 秒 */
+    maxIdleTimeout?: number;
+    /** 最大传入流数量，默认值为 100000 */
+    maxIncomingStreams?: number;
+}
+/** 端口范围配置 */
+interface PortsRange {
+    /** 起始端口 */
+    start?: number;
+    /** 终止端口 */
+    end?: number;
+    /** 单一端口 */
+    single?: number;
+}
+/** HTTP 头部操作配置 */
+interface HeaderOperations {
+    /** 在 Header 中设置指定的 KV 值 */
+    set?: Record<string, string>;
+}
+/** HTTP 头部配置 */
+interface HTTPHeader {
+    /** Header 名称 */
+    name: string;
+    /** Header 值 */
+    value: string;
+}
+/** 文件数据源配置 */
+interface FileSource {
+    /** 文件路径 */
+    path: string;
+}
+/** 数据源类型 */
+type ValueSourceType = 'file';
+/** 值数据源配置 */
+interface ValueSource {
+    /** 数据源类型，目前仅支持 "file" */
+    type: ValueSourceType;
+    /** 文件数据源配置，当 type 为 "file" 时必填 */
+    file?: FileSource;
+}
+/** NAT 穿透配置 */
+interface NatTraversalConfig {
+    /**
+     * 禁用本地网络接口地址的辅助连接。当启用时，仅使用通过 STUN 发现的公网地址进行 NAT 打洞，
+     * 避免使用可能较慢的本地网络接口（如 VPN）。默认为 false
+     */
+    disableAssistedAddrs?: boolean;
+}
+
+/**
+ * FRP 服务端配置类型定义
+ * 基于 frp 官方文档: https://gofrp.org/zh-cn/docs/reference/server-configures/
+ */
+
+/** 鉴权方式类型 */
+type AuthMethod = 'token' | 'oidc';
+/** 鉴权信息附加范围类型 */
+type AuthScope = 'HeartBeats' | 'NewWorkConns';
+/** OIDC 服务端鉴权配置 */
+interface AuthOIDCServerConfig {
+    /** OIDC 发行者 */
+    issuer?: string;
+    /** OIDC 受众 */
+    audience?: string;
+    /** 跳过过期检查 */
+    skipExpiryCheck?: boolean;
+    /** 跳过发行者检查 */
+    skipIssuerCheck?: boolean;
+}
+/** 服务端鉴权配置 */
+interface AuthServerConfig {
+    /** 鉴权方式，可选值为 token 或 oidc，默认为 token */
+    method?: AuthMethod;
+    /** 鉴权信息附加范围，可选值为 HeartBeats 和 NewWorkConns */
+    additionalScopes?: AuthScope[];
+    /** 在 method 为 token 时生效，客户端需要设置一样的值才能鉴权通过。与 tokenSource 字段互斥 */
+    token?: string;
+    /** 从文件中加载 token 的配置。与 token 字段互斥 */
+    tokenSource?: ValueSource;
+    /** oidc 鉴权配置 */
+    oidc?: AuthOIDCServerConfig;
+}
+/** 服务端 TLS 配置 */
+interface TLSServerConfig extends TLSConfig {
+    /** 是否只接受启用了 TLS 的客户端连接 */
+    force?: boolean;
+}
+/** 服务端传输层配置 */
+interface ServerTransportConfig {
+    /** tcp mux 的心跳检查间隔时间，单位秒 */
+    tcpMuxKeepaliveInterval?: number;
+    /** 和客户端底层 TCP 连接的 keepalive 间隔时间，单位秒，配置为负数表示不启用 */
+    tcpKeepalive?: number;
+    /** 允许客户端设置的最大连接池大小，如果客户端配置的值大于此值，会被强制修改为最大值，默认为 5 */
+    maxPoolCount?: number;
+    /** 服务端和客户端心跳连接的超时时间，单位秒，默认为 90 秒 */
+    heartbeatTimeout?: number;
+    /** QUIC 协议配置参数 */
+    quic?: QUICOptions;
+    /** 服务端 TLS 协议配置 */
+    tls?: TLSServerConfig;
+}
+/** HTTP 插件选项 */
+interface HTTPPluginOptions {
+    /** 插件名称 */
+    name: string;
+    /** 插件接口的地址 */
+    addr: string;
+    /** 插件接口的 Path */
+    path: string;
+    /** 插件需要生效的操作列表，具体可选值请参考服务端插件的说明文档 */
+    ops: string[];
+    /** 当插件地址为 HTTPS 协议时，是否校验插件的 TLS 证书，默认为不校验 */
+    tlsVerify?: boolean;
+}
+/** SSH 隧道网关配置 */
+interface SSHTunnelGateway {
+    /** SSH 服务器监听端口 */
+    bindPort: number;
+    /** SSH 服务器私钥文件路径。若为空，frps将读取autoGenPrivateKeyPath路径下的私钥文件 */
+    privateKeyFile?: string;
+    /** 私钥文件自动生成路径，默认为./.autogen_ssh_key。若文件不存在或内容为空，frps将自动生成RSA私钥文件并存储到该路径 */
+    autoGenPrivateKeyPath?: string;
+    /** SSH 客户端授权密钥文件路径。若为空，则不进行SSH客户端鉴权认证。非空可实现SSH免密登录认证 */
+    authorizedKeysFile?: string;
+}
+/** 服务端配置 */
+interface ServerConfig {
+    /** 鉴权配置 */
+    auth?: AuthServerConfig;
+    /** 服务端监听地址，用于接收 frpc 的连接，默认监听 0.0.0.0 */
+    bindAddr?: string;
+    /** 服务端监听端口，默认值为 7000 */
+    bindPort?: number;
+    /** 服务端监听 KCP 协议端口，用于接收配置了使用 KCP 协议的 frpc 连接 */
+    kcpBindPort?: number;
+    /** 服务端监听 QUIC 协议端口，用于接收配置了使用 QUIC 协议的 frpc 连接 */
+    quicBindPort?: number;
+    /** 代理监听地址，可以使代理监听在不同的网卡地址，默认情况下同 bindAddr */
+    proxyBindAddr?: string;
+    /** HTTP 类型代理监听的端口，启用后才能支持 HTTP 类型的代理 */
+    vhostHTTPPort?: number;
+    /** HTTP 类型代理在服务端的 ResponseHeader 超时时间，默认为 60s */
+    vhostHTTPTimeout?: number;
+    /** HTTPS 类型代理监听的端口，启用后才能支持 HTTPS 类型的代理 */
+    vhostHTTPSPort?: number;
+    /** tcpmux 类型且复用器为 httpconnect 的代理监听的端口 */
+    tcpmuxHTTPConnectPort?: number;
+    /** 对于 tcpmux 类型的代理是否透传 CONNECT 请求 */
+    tcpmuxPassthrough?: boolean;
+    /** 二级域名后缀 */
+    subDomainHost?: string;
+    /** 自定义 404 错误页面地址 */
+    custom404Page?: string;
+    /** ssh 隧道网关配置 */
+    sshTunnelGateway?: SSHTunnelGateway;
+    /** 服务端 Dashboard 配置 */
+    webServer?: WebServerConfig;
+    /** 是否提供 Prometheus 监控接口，需要同时启用了 webServer 后才会生效 */
+    enablePrometheus?: boolean;
+    /** 日志配置 */
+    log?: LogConfig;
+    /** 网络层配置 */
+    transport?: ServerTransportConfig;
+    /** 服务端返回详细错误信息给客户端，默认为 true */
+    detailedErrorsToClient?: boolean;
+    /** 限制单个客户端最大同时存在的代理数，默认无限制 */
+    maxPortsPerClient?: number;
+    /** 用户建立连接后等待客户端响应的超时时间，单位秒，默认为 10 秒 */
+    userConnTimeout?: number;
+    /** 代理 UDP 服务时支持的最大包长度，默认为 1500，服务端和客户端的值需要一致 */
+    udpPacketSize?: number;
+    /** 打洞策略数据的保留时间，默认为 168 小时，即 7 天 */
+    natholeAnalysisDataReserveHours?: number;
+    /** 允许代理绑定的服务端端口 */
+    allowPorts?: PortsRange[];
+    /** 服务端 HTTP 插件配置 */
+    httpPlugins?: HTTPPluginOptions[];
+}
+
+/**
+ * FRP 客户端配置类型定义
+ * 基于 frp 官方文档: https://gofrp.org/zh-cn/docs/reference/client-configures/
+ */
+
+/** 客户端传输协议类型 */
+type ClientTransportProtocol = 'tcp' | 'kcp' | 'quic' | 'websocket' | 'wss';
+/** OIDC 客户端鉴权配置 */
+interface AuthOIDCClientConfig {
+    /** OIDC 客户端 ID */
+    clientID?: string;
+    /** OIDC 客户端密钥 */
+    clientSecret?: string;
+    /** OIDC audience 参数 */
+    audience?: string;
+    /** OIDC scope 参数 */
+    scope?: string;
+    /** OIDC 令牌端点 URL */
+    tokenEndpointURL?: string;
+    /** 附加的端点参数 */
+    additionalEndpointParams?: Record<string, string>;
+    /** 信任的 CA 证书文件路径，用于验证 OIDC 服务器的 TLS 证书 */
+    trustedCaFile?: string;
+    /** 跳过 TLS 证书验证，不推荐在生产环境使用 */
+    insecureSkipVerify?: boolean;
+    /** 访问 OIDC 令牌端点时使用的代理服务器 URL */
+    proxyURL?: string;
+}
+/** 客户端鉴权配置 */
+interface AuthClientConfig {
+    /** 鉴权方式，可选值为 token 或 oidc，默认为 token */
+    method?: AuthMethod;
+    /** 鉴权信息附加范围，可选值为 HeartBeats 和 NewWorkConns */
+    additionalScopes?: AuthScope[];
+    /** 在 method 为 token 时生效，客户端需要设置一样的值才能鉴权通过。与 tokenSource 字段互斥 */
+    token?: string;
+    /** 从文件中加载 token 的配置。与 token 字段互斥 */
+    tokenSource?: ValueSource;
+    /** oidc 鉴权配置 */
+    oidc?: AuthOIDCClientConfig;
+}
+/** 客户端 TLS 配置 */
+interface TLSClientConfig extends TLSConfig {
+    /** 是否和服务端之间启用 TLS 连接，默认启用 */
+    enable?: boolean;
+    /** 启用 TLS 连接时，不发送 0x17 特殊字节。默认为 true。当配置为 true 时，无法和 vhostHTTPSPort 端口复用 */
+    disableCustomTLSFirstByte?: boolean;
+}
+/** 客户端传输层配置 */
+interface ClientTransportConfig {
+    /** 和 frps 之间的通信协议，可选值为 tcp, kcp, quic, websocket, wss。默认为 tcp */
+    protocol?: ClientTransportProtocol;
+    /** 连接服务端的超时时间，默认为 10s */
+    dialServerTimeout?: number;
+    /** 和服务端底层 TCP 连接的 keepalive 间隔时间，单位秒 */
+    dialServerKeepalive?: number;
+    /** 连接服务端时所绑定的本地 IP */
+    connectServerLocalIP?: string;
+    /** 连接服务端使用的代理地址，格式为 {protocol}://user:passwd@192.168.1.128:8080 protocol 目前支持 http、socks5、ntlm */
+    proxyURL?: string;
+    /** 连接池大小 */
+    poolCount?: number;
+    /** TCP 多路复用，默认启用 */
+    tcpMux?: boolean;
+    /** tcp_mux 的心跳检查间隔时间 */
+    tcpMuxKeepaliveInterval?: number;
+    /** QUIC 协议配置参数 */
+    quic?: QUICOptions;
+    /** 向服务端发送心跳包的间隔时间，默认为 30s。建议启用 tcp_mux_keepalive_interval，将此值设置为 -1 */
+    heartbeatInterval?: number;
+    /** 和服务端心跳的超时时间，默认为 90s */
+    heartbeatTimeout?: number;
+    /** 客户端 TLS 协议配置 */
+    tls?: TLSClientConfig;
+}
+/** 虚拟网络配置 */
+interface VirtualNetConfig {
+    /** 虚拟网络接口的 IP 地址和网段，格式为 CIDR (例如 "100.86.0.1/24") */
+    address: string;
+}
+/** 客户端通用配置 */
+interface ClientCommonConfig {
+    /** 客户端鉴权配置 */
+    auth?: AuthClientConfig;
+    /** 用户名，设置此参数后，代理名称会被修改为 {user}.{proxyName}，避免代理名称和其他用户冲突 */
+    user?: string;
+    /** 连接服务端的地址 */
+    serverAddr?: string;
+    /** 连接服务端的端口，默认为 7000 */
+    serverPort?: number;
+    /** xtcp 打洞所需的 stun 服务器地址，默认为 stun.easyvoip.com:3478 */
+    natHoleStunServer?: string;
+    /** 使用 DNS 服务器地址，默认使用系统配置的 DNS 服务器，指定此参数可以强制替换为自定义的 DNS 服务器地址 */
+    dnsServer?: string;
+    /** 第一次登陆失败后是否退出，默认为 true */
+    loginFailExit?: boolean;
+    /** 指定启用部分代理，当配置了较多代理，但是只希望启用其中部分时可以通过此参数指定，默认为全部启用 */
+    start?: string[];
+    /** 日志配置 */
+    log?: LogConfig;
+    /** 客户端 AdminServer 配置 */
+    webServer?: WebServerConfig;
+    /** 客户端网络层配置 */
+    transport?: ClientTransportConfig;
+    /** 虚拟网络配置，Alpha 特性 */
+    virtualNet?: VirtualNetConfig;
+    /** 特性门控，用于启用或禁用实验性功能 */
+    featureGates?: Record<string, boolean>;
+    /** 代理 UDP 服务时支持的最大包长度，默认为 1500，服务端和客户端需要保持配置一致 */
+    udpPacketSize?: number;
+    /** 附加元数据，会传递给服务端插件，提供附加能力 */
+    metadatas?: Record<string, string>;
+    /** 指定额外的配置文件目录，其中的 proxy 和 visitor 配置会被读取加载 */
+    includes?: string[];
+}
+/** 客户端配置 */
+interface ClientConfig extends ClientCommonConfig {
+}
+
+/**
+ * FRP Proxy configuration types
+ * Based on: https://gofrp.org/zh-cn/docs/reference/proxy-config/
+ */
+/** Proxy type */
+type ProxyType = 'tcp' | 'udp' | 'http' | 'https' | 'tcpmux' | 'stcp' | 'xtcp' | 'sudp';
+/** Load balancer strategy */
+type LoadBalancerStrategy = 'random' | 'round_robin';
+/** Base proxy configuration */
+interface BaseProxyConfig {
+    /** Proxy name (unique) */
+    name: string;
+    /** Proxy type */
+    type: ProxyType;
+    /** Local IP to bind */
+    localIP?: string;
+    /** Local port */
+    localPort?: number;
+    /** Additional metadata */
+    annotations?: Record<string, string>;
+    /** Custom metadata passed to server plugins */
+    metadatas?: Record<string, string>;
+    /** Load balancer settings */
+    loadBalancer?: {
+        /** Load balancing strategy */
+        strategy?: LoadBalancerStrategy;
+        /** Health check configuration */
+        healthCheck?: {
+            /** Health check type */
+            type?: 'tcp' | 'http';
+            /** Health check timeout (seconds) */
+            timeoutSeconds?: number;
+            /** Max failed checks before marking unhealthy */
+            maxFailed?: number;
+            /** Check interval (seconds) */
+            intervalSeconds?: number;
+            /** HTTP health check path */
+            path?: string;
+        };
+    };
+    /** Enable bandwidth limit */
+    transport?: {
+        /** Bandwidth limit (KB/s) */
+        bandwidthLimit?: string;
+        /** Bandwidth limit mode */
+        bandwidthLimitMode?: 'client' | 'server';
+    };
+}
+/** TCP proxy configuration */
+interface TCPProxyConfig extends BaseProxyConfig {
+    type: 'tcp';
+    /** Remote port on server */
+    remotePort?: number;
+}
+/** UDP proxy configuration */
+interface UDPProxyConfig extends BaseProxyConfig {
+    type: 'udp';
+    /** Remote port on server */
+    remotePort?: number;
+}
+/** HTTP proxy configuration */
+interface HTTPProxyConfig extends BaseProxyConfig {
+    type: 'http';
+    /** Custom domain names */
+    customDomains?: string[];
+    /** Subdomain under server's subdomain_host */
+    subdomain?: string;
+    /** Locations to proxy */
+    locations?: string[];
+    /** Host header rewrite */
+    hostHeaderRewrite?: string;
+    /** HTTP username for basic auth */
+    httpUser?: string;
+    /** HTTP password for basic auth */
+    httpPassword?: string;
+    /** Request headers to set */
+    requestHeaders?: {
+        set?: Record<string, string>;
+    };
+    /** Response headers to set */
+    responseHeaders?: {
+        set?: Record<string, string>;
+    };
+    /** Route by HTTP user */
+    routeByHTTPUser?: string;
+}
+/** HTTPS proxy configuration */
+interface HTTPSProxyConfig extends BaseProxyConfig {
+    type: 'https';
+    /** Custom domain names */
+    customDomains?: string[];
+    /** Subdomain under server's subdomain_host */
+    subdomain?: string;
+}
+/** TCPMUX proxy configuration */
+interface TCPMUXProxyConfig extends BaseProxyConfig {
+    type: 'tcpmux';
+    /** Multiplexer type */
+    multiplexer?: 'httpconnect';
+    /** Custom domain names */
+    customDomains?: string[];
+    /** Subdomain under server's subdomain_host */
+    subdomain?: string;
+    /** Route by HTTP user */
+    routeByHTTPUser?: string;
+    /** HTTP username */
+    httpUser?: string;
+    /** HTTP password */
+    httpPassword?: string;
+}
+/** STCP proxy configuration */
+interface STCPProxyConfig extends BaseProxyConfig {
+    type: 'stcp';
+    /** Secret key shared with visitor */
+    secretKey?: string;
+    /** Allowed visitor users */
+    allowUsers?: string[];
+}
+/** XTCP proxy configuration */
+interface XTCPProxyConfig extends BaseProxyConfig {
+    type: 'xtcp';
+    /** Secret key shared with visitor */
+    secretKey?: string;
+    /** Allowed visitor users */
+    allowUsers?: string[];
+}
+/** SUDP proxy configuration */
+interface SUDPProxyConfig extends BaseProxyConfig {
+    type: 'sudp';
+    /** Secret key shared with visitor */
+    secretKey?: string;
+    /** Allowed visitor users */
+    allowUsers?: string[];
+}
+/** Union type of all proxy configurations */
+type ProxyConfig = TCPProxyConfig | UDPProxyConfig | HTTPProxyConfig | HTTPSProxyConfig | TCPMUXProxyConfig | STCPProxyConfig | XTCPProxyConfig | SUDPProxyConfig;
+/** Visitor type */
+type VisitorType = 'stcp' | 'xtcp' | 'sudp';
+/** Base visitor configuration */
+interface BaseVisitorConfig {
+    /** Visitor name (unique) */
+    name: string;
+    /** Visitor type */
+    type: VisitorType;
+    /** Server name to connect to */
+    serverName: string;
+    /** Secret key shared with proxy */
+    secretKey?: string;
+    /** Local IP to bind */
+    bindAddr?: string;
+    /** Local port to bind */
+    bindPort?: number;
+}
+/** STCP visitor configuration */
+interface STCPVisitorConfig extends BaseVisitorConfig {
+    type: 'stcp';
+}
+/** XTCP visitor configuration */
+interface XTCPVisitorConfig extends BaseVisitorConfig {
+    type: 'xtcp';
+    /** Keep tunnel alive even when no connection */
+    keepTunnelOpen?: boolean;
+    /** Max retries for establishing connection */
+    maxRetriesAnHour?: number;
+    /** Min retry interval (seconds) */
+    minRetryInterval?: number;
+    /** Fallback to STCP when XTCP fails */
+    fallbackTo?: string;
+    /** Fallback timeout (seconds) */
+    fallbackTimeoutMs?: number;
+}
+/** SUDP visitor configuration */
+interface SUDPVisitorConfig extends BaseVisitorConfig {
+    type: 'sudp';
+}
+/** Union type of all visitor configurations */
+type VisitorConfig = STCPVisitorConfig | XTCPVisitorConfig | SUDPVisitorConfig;
+
+export type { AuthClientConfig, AuthMethod, AuthOIDCClientConfig, AuthOIDCServerConfig, AuthScope, AuthServerConfig, BaseProxyConfig, BaseVisitorConfig, ClientCommonConfig, ClientConfig, ClientTransportConfig, ClientTransportProtocol, FileSource, HTTPHeader, HTTPPluginOptions, HTTPProxyConfig, HTTPSProxyConfig, HeaderOperations, LoadBalancerStrategy, LogConfig, LogLevel, NatTraversalConfig, PortsRange, ProxyConfig, ProxyType, QUICOptions, SSHTunnelGateway, STCPProxyConfig, STCPVisitorConfig, SUDPProxyConfig, SUDPVisitorConfig, ServerConfig, ServerTransportConfig, TCPMUXProxyConfig, TCPProxyConfig, TLSClientConfig, TLSConfig, TLSServerConfig, UDPProxyConfig, ValueSource, ValueSourceType, VirtualNetConfig, VisitorConfig, VisitorType, WebServerConfig, XTCPProxyConfig, XTCPVisitorConfig };

package/dist/index.d.ts

@@ -0,0 +1,527 @@
+/**
+ * FRP 通用配置类型定义
+ * 基于 frp 官方文档: https://gofrp.org/zh-cn/docs/reference/common/
+ */
+/** 日志级别类型 */
+type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error';
+/** 日志配置 */
+interface LogConfig {
+    /** 日志输出文件路径，如果为 console，则会将日志打印在标准输出中 */
+    to?: string;
+    /** 日志级别，可选值为 trace, debug, info, warn, error，默认级别为 info */
+    level?: LogLevel;
+    /** 日志文件最多保留天数，默认为 3 天 */
+    maxDays?: number;
+    /** 禁用标准输出中的日志颜色 */
+    disablePrintColor?: boolean;
+}
+/** TLS 配置 */
+interface TLSConfig {
+    /** TLS 证书文件路径 */
+    certFile: string;
+    /** TLS 密钥文件路径 */
+    keyFile: string;
+    /** CA 证书文件路径 */
+    trustedCaFile?: string;
+    /** TLS Server 名称 */
+    serverName?: string;
+}
+/** Web 服务器配置 */
+interface WebServerConfig {
+    /** webServer 监听地址，默认为 127.0.0.1 */
+    addr?: string;
+    /** webServer 监听端口 */
+    port: number;
+    /** HTTP BasicAuth 用户名 */
+    user?: string;
+    /** HTTP BasicAuth 密码 */
+    password?: string;
+    /** 静态资源目录，Dashboard 使用的资源默认打包在二进制文件中，通过指定此参数使用自定义的静态资源 */
+    assetsDir?: string;
+    /** 启动 Go HTTP pprof，用于应用调试 */
+    pprofEnable?: boolean;
+    /** Dashboard 启用 HTTPS 的 TLS 相关配置 */
+    tls?: TLSConfig;
+}
+/** QUIC 协议选项 */
+interface QUICOptions {
+    /** 保活周期，默认值为 10 秒 */
+    keepalivePeriod?: number;
+    /** 最大空闲超时时间，默认值为 30 秒 */
+    maxIdleTimeout?: number;
+    /** 最大传入流数量，默认值为 100000 */
+    maxIncomingStreams?: number;
+}
+/** 端口范围配置 */
+interface PortsRange {
+    /** 起始端口 */
+    start?: number;
+    /** 终止端口 */
+    end?: number;
+    /** 单一端口 */
+    single?: number;
+}
+/** HTTP 头部操作配置 */
+interface HeaderOperations {
+    /** 在 Header 中设置指定的 KV 值 */
+    set?: Record<string, string>;
+}
+/** HTTP 头部配置 */
+interface HTTPHeader {
+    /** Header 名称 */
+    name: string;
+    /** Header 值 */
+    value: string;
+}
+/** 文件数据源配置 */
+interface FileSource {
+    /** 文件路径 */
+    path: string;
+}
+/** 数据源类型 */
+type ValueSourceType = 'file';
+/** 值数据源配置 */
+interface ValueSource {
+    /** 数据源类型，目前仅支持 "file" */
+    type: ValueSourceType;
+    /** 文件数据源配置，当 type 为 "file" 时必填 */
+    file?: FileSource;
+}
+/** NAT 穿透配置 */
+interface NatTraversalConfig {
+    /**
+     * 禁用本地网络接口地址的辅助连接。当启用时，仅使用通过 STUN 发现的公网地址进行 NAT 打洞，
+     * 避免使用可能较慢的本地网络接口（如 VPN）。默认为 false
+     */
+    disableAssistedAddrs?: boolean;
+}
+
+/**
+ * FRP 服务端配置类型定义
+ * 基于 frp 官方文档: https://gofrp.org/zh-cn/docs/reference/server-configures/
+ */
+
+/** 鉴权方式类型 */
+type AuthMethod = 'token' | 'oidc';
+/** 鉴权信息附加范围类型 */
+type AuthScope = 'HeartBeats' | 'NewWorkConns';
+/** OIDC 服务端鉴权配置 */
+interface AuthOIDCServerConfig {
+    /** OIDC 发行者 */
+    issuer?: string;
+    /** OIDC 受众 */
+    audience?: string;
+    /** 跳过过期检查 */
+    skipExpiryCheck?: boolean;
+    /** 跳过发行者检查 */
+    skipIssuerCheck?: boolean;
+}
+/** 服务端鉴权配置 */
+interface AuthServerConfig {
+    /** 鉴权方式，可选值为 token 或 oidc，默认为 token */
+    method?: AuthMethod;
+    /** 鉴权信息附加范围，可选值为 HeartBeats 和 NewWorkConns */
+    additionalScopes?: AuthScope[];
+    /** 在 method 为 token 时生效，客户端需要设置一样的值才能鉴权通过。与 tokenSource 字段互斥 */
+    token?: string;
+    /** 从文件中加载 token 的配置。与 token 字段互斥 */
+    tokenSource?: ValueSource;
+    /** oidc 鉴权配置 */
+    oidc?: AuthOIDCServerConfig;
+}
+/** 服务端 TLS 配置 */
+interface TLSServerConfig extends TLSConfig {
+    /** 是否只接受启用了 TLS 的客户端连接 */
+    force?: boolean;
+}
+/** 服务端传输层配置 */
+interface ServerTransportConfig {
+    /** tcp mux 的心跳检查间隔时间，单位秒 */
+    tcpMuxKeepaliveInterval?: number;
+    /** 和客户端底层 TCP 连接的 keepalive 间隔时间，单位秒，配置为负数表示不启用 */
+    tcpKeepalive?: number;
+    /** 允许客户端设置的最大连接池大小，如果客户端配置的值大于此值，会被强制修改为最大值，默认为 5 */
+    maxPoolCount?: number;
+    /** 服务端和客户端心跳连接的超时时间，单位秒，默认为 90 秒 */
+    heartbeatTimeout?: number;
+    /** QUIC 协议配置参数 */
+    quic?: QUICOptions;
+    /** 服务端 TLS 协议配置 */
+    tls?: TLSServerConfig;
+}
+/** HTTP 插件选项 */
+interface HTTPPluginOptions {
+    /** 插件名称 */
+    name: string;
+    /** 插件接口的地址 */
+    addr: string;
+    /** 插件接口的 Path */
+    path: string;
+    /** 插件需要生效的操作列表，具体可选值请参考服务端插件的说明文档 */
+    ops: string[];
+    /** 当插件地址为 HTTPS 协议时，是否校验插件的 TLS 证书，默认为不校验 */
+    tlsVerify?: boolean;
+}
+/** SSH 隧道网关配置 */
+interface SSHTunnelGateway {
+    /** SSH 服务器监听端口 */
+    bindPort: number;
+    /** SSH 服务器私钥文件路径。若为空，frps将读取autoGenPrivateKeyPath路径下的私钥文件 */
+    privateKeyFile?: string;
+    /** 私钥文件自动生成路径，默认为./.autogen_ssh_key。若文件不存在或内容为空，frps将自动生成RSA私钥文件并存储到该路径 */
+    autoGenPrivateKeyPath?: string;
+    /** SSH 客户端授权密钥文件路径。若为空，则不进行SSH客户端鉴权认证。非空可实现SSH免密登录认证 */
+    authorizedKeysFile?: string;
+}
+/** 服务端配置 */
+interface ServerConfig {
+    /** 鉴权配置 */
+    auth?: AuthServerConfig;
+    /** 服务端监听地址，用于接收 frpc 的连接，默认监听 0.0.0.0 */
+    bindAddr?: string;
+    /** 服务端监听端口，默认值为 7000 */
+    bindPort?: number;
+    /** 服务端监听 KCP 协议端口，用于接收配置了使用 KCP 协议的 frpc 连接 */
+    kcpBindPort?: number;
+    /** 服务端监听 QUIC 协议端口，用于接收配置了使用 QUIC 协议的 frpc 连接 */
+    quicBindPort?: number;
+    /** 代理监听地址，可以使代理监听在不同的网卡地址，默认情况下同 bindAddr */
+    proxyBindAddr?: string;
+    /** HTTP 类型代理监听的端口，启用后才能支持 HTTP 类型的代理 */
+    vhostHTTPPort?: number;
+    /** HTTP 类型代理在服务端的 ResponseHeader 超时时间，默认为 60s */
+    vhostHTTPTimeout?: number;
+    /** HTTPS 类型代理监听的端口，启用后才能支持 HTTPS 类型的代理 */
+    vhostHTTPSPort?: number;
+    /** tcpmux 类型且复用器为 httpconnect 的代理监听的端口 */
+    tcpmuxHTTPConnectPort?: number;
+    /** 对于 tcpmux 类型的代理是否透传 CONNECT 请求 */
+    tcpmuxPassthrough?: boolean;
+    /** 二级域名后缀 */
+    subDomainHost?: string;
+    /** 自定义 404 错误页面地址 */
+    custom404Page?: string;
+    /** ssh 隧道网关配置 */
+    sshTunnelGateway?: SSHTunnelGateway;
+    /** 服务端 Dashboard 配置 */
+    webServer?: WebServerConfig;
+    /** 是否提供 Prometheus 监控接口，需要同时启用了 webServer 后才会生效 */
+    enablePrometheus?: boolean;
+    /** 日志配置 */
+    log?: LogConfig;
+    /** 网络层配置 */
+    transport?: ServerTransportConfig;
+    /** 服务端返回详细错误信息给客户端，默认为 true */
+    detailedErrorsToClient?: boolean;
+    /** 限制单个客户端最大同时存在的代理数，默认无限制 */
+    maxPortsPerClient?: number;
+    /** 用户建立连接后等待客户端响应的超时时间，单位秒，默认为 10 秒 */
+    userConnTimeout?: number;
+    /** 代理 UDP 服务时支持的最大包长度，默认为 1500，服务端和客户端的值需要一致 */
+    udpPacketSize?: number;
+    /** 打洞策略数据的保留时间，默认为 168 小时，即 7 天 */
+    natholeAnalysisDataReserveHours?: number;
+    /** 允许代理绑定的服务端端口 */
+    allowPorts?: PortsRange[];
+    /** 服务端 HTTP 插件配置 */
+    httpPlugins?: HTTPPluginOptions[];
+}
+
+/**
+ * FRP 客户端配置类型定义
+ * 基于 frp 官方文档: https://gofrp.org/zh-cn/docs/reference/client-configures/
+ */
+
+/** 客户端传输协议类型 */
+type ClientTransportProtocol = 'tcp' | 'kcp' | 'quic' | 'websocket' | 'wss';
+/** OIDC 客户端鉴权配置 */
+interface AuthOIDCClientConfig {
+    /** OIDC 客户端 ID */
+    clientID?: string;
+    /** OIDC 客户端密钥 */
+    clientSecret?: string;
+    /** OIDC audience 参数 */
+    audience?: string;
+    /** OIDC scope 参数 */
+    scope?: string;
+    /** OIDC 令牌端点 URL */
+    tokenEndpointURL?: string;
+    /** 附加的端点参数 */
+    additionalEndpointParams?: Record<string, string>;
+    /** 信任的 CA 证书文件路径，用于验证 OIDC 服务器的 TLS 证书 */
+    trustedCaFile?: string;
+    /** 跳过 TLS 证书验证，不推荐在生产环境使用 */
+    insecureSkipVerify?: boolean;
+    /** 访问 OIDC 令牌端点时使用的代理服务器 URL */
+    proxyURL?: string;
+}
+/** 客户端鉴权配置 */
+interface AuthClientConfig {
+    /** 鉴权方式，可选值为 token 或 oidc，默认为 token */
+    method?: AuthMethod;
+    /** 鉴权信息附加范围，可选值为 HeartBeats 和 NewWorkConns */
+    additionalScopes?: AuthScope[];
+    /** 在 method 为 token 时生效，客户端需要设置一样的值才能鉴权通过。与 tokenSource 字段互斥 */
+    token?: string;
+    /** 从文件中加载 token 的配置。与 token 字段互斥 */
+    tokenSource?: ValueSource;
+    /** oidc 鉴权配置 */
+    oidc?: AuthOIDCClientConfig;
+}
+/** 客户端 TLS 配置 */
+interface TLSClientConfig extends TLSConfig {
+    /** 是否和服务端之间启用 TLS 连接，默认启用 */
+    enable?: boolean;
+    /** 启用 TLS 连接时，不发送 0x17 特殊字节。默认为 true。当配置为 true 时，无法和 vhostHTTPSPort 端口复用 */
+    disableCustomTLSFirstByte?: boolean;
+}
+/** 客户端传输层配置 */
+interface ClientTransportConfig {
+    /** 和 frps 之间的通信协议，可选值为 tcp, kcp, quic, websocket, wss。默认为 tcp */
+    protocol?: ClientTransportProtocol;
+    /** 连接服务端的超时时间，默认为 10s */
+    dialServerTimeout?: number;
+    /** 和服务端底层 TCP 连接的 keepalive 间隔时间，单位秒 */
+    dialServerKeepalive?: number;
+    /** 连接服务端时所绑定的本地 IP */
+    connectServerLocalIP?: string;
+    /** 连接服务端使用的代理地址，格式为 {protocol}://user:passwd@192.168.1.128:8080 protocol 目前支持 http、socks5、ntlm */
+    proxyURL?: string;
+    /** 连接池大小 */
+    poolCount?: number;
+    /** TCP 多路复用，默认启用 */
+    tcpMux?: boolean;
+    /** tcp_mux 的心跳检查间隔时间 */
+    tcpMuxKeepaliveInterval?: number;
+    /** QUIC 协议配置参数 */
+    quic?: QUICOptions;
+    /** 向服务端发送心跳包的间隔时间，默认为 30s。建议启用 tcp_mux_keepalive_interval，将此值设置为 -1 */
+    heartbeatInterval?: number;
+    /** 和服务端心跳的超时时间，默认为 90s */
+    heartbeatTimeout?: number;
+    /** 客户端 TLS 协议配置 */
+    tls?: TLSClientConfig;
+}
+/** 虚拟网络配置 */
+interface VirtualNetConfig {
+    /** 虚拟网络接口的 IP 地址和网段，格式为 CIDR (例如 "100.86.0.1/24") */
+    address: string;
+}
+/** 客户端通用配置 */
+interface ClientCommonConfig {
+    /** 客户端鉴权配置 */
+    auth?: AuthClientConfig;
+    /** 用户名，设置此参数后，代理名称会被修改为 {user}.{proxyName}，避免代理名称和其他用户冲突 */
+    user?: string;
+    /** 连接服务端的地址 */
+    serverAddr?: string;
+    /** 连接服务端的端口，默认为 7000 */
+    serverPort?: number;
+    /** xtcp 打洞所需的 stun 服务器地址，默认为 stun.easyvoip.com:3478 */
+    natHoleStunServer?: string;
+    /** 使用 DNS 服务器地址，默认使用系统配置的 DNS 服务器，指定此参数可以强制替换为自定义的 DNS 服务器地址 */
+    dnsServer?: string;
+    /** 第一次登陆失败后是否退出，默认为 true */
+    loginFailExit?: boolean;
+    /** 指定启用部分代理，当配置了较多代理，但是只希望启用其中部分时可以通过此参数指定，默认为全部启用 */
+    start?: string[];
+    /** 日志配置 */
+    log?: LogConfig;
+    /** 客户端 AdminServer 配置 */
+    webServer?: WebServerConfig;
+    /** 客户端网络层配置 */
+    transport?: ClientTransportConfig;
+    /** 虚拟网络配置，Alpha 特性 */
+    virtualNet?: VirtualNetConfig;
+    /** 特性门控，用于启用或禁用实验性功能 */
+    featureGates?: Record<string, boolean>;
+    /** 代理 UDP 服务时支持的最大包长度，默认为 1500，服务端和客户端需要保持配置一致 */
+    udpPacketSize?: number;
+    /** 附加元数据，会传递给服务端插件，提供附加能力 */
+    metadatas?: Record<string, string>;
+    /** 指定额外的配置文件目录，其中的 proxy 和 visitor 配置会被读取加载 */
+    includes?: string[];
+}
+/** 客户端配置 */
+interface ClientConfig extends ClientCommonConfig {
+}
+
+/**
+ * FRP Proxy configuration types
+ * Based on: https://gofrp.org/zh-cn/docs/reference/proxy-config/
+ */
+/** Proxy type */
+type ProxyType = 'tcp' | 'udp' | 'http' | 'https' | 'tcpmux' | 'stcp' | 'xtcp' | 'sudp';
+/** Load balancer strategy */
+type LoadBalancerStrategy = 'random' | 'round_robin';
+/** Base proxy configuration */
+interface BaseProxyConfig {
+    /** Proxy name (unique) */
+    name: string;
+    /** Proxy type */
+    type: ProxyType;
+    /** Local IP to bind */
+    localIP?: string;
+    /** Local port */
+    localPort?: number;
+    /** Additional metadata */
+    annotations?: Record<string, string>;
+    /** Custom metadata passed to server plugins */
+    metadatas?: Record<string, string>;
+    /** Load balancer settings */
+    loadBalancer?: {
+        /** Load balancing strategy */
+        strategy?: LoadBalancerStrategy;
+        /** Health check configuration */
+        healthCheck?: {
+            /** Health check type */
+            type?: 'tcp' | 'http';
+            /** Health check timeout (seconds) */
+            timeoutSeconds?: number;
+            /** Max failed checks before marking unhealthy */
+            maxFailed?: number;
+            /** Check interval (seconds) */
+            intervalSeconds?: number;
+            /** HTTP health check path */
+            path?: string;
+        };
+    };
+    /** Enable bandwidth limit */
+    transport?: {
+        /** Bandwidth limit (KB/s) */
+        bandwidthLimit?: string;
+        /** Bandwidth limit mode */
+        bandwidthLimitMode?: 'client' | 'server';
+    };
+}
+/** TCP proxy configuration */
+interface TCPProxyConfig extends BaseProxyConfig {
+    type: 'tcp';
+    /** Remote port on server */
+    remotePort?: number;
+}
+/** UDP proxy configuration */
+interface UDPProxyConfig extends BaseProxyConfig {
+    type: 'udp';
+    /** Remote port on server */
+    remotePort?: number;
+}
+/** HTTP proxy configuration */
+interface HTTPProxyConfig extends BaseProxyConfig {
+    type: 'http';
+    /** Custom domain names */
+    customDomains?: string[];
+    /** Subdomain under server's subdomain_host */
+    subdomain?: string;
+    /** Locations to proxy */
+    locations?: string[];
+    /** Host header rewrite */
+    hostHeaderRewrite?: string;
+    /** HTTP username for basic auth */
+    httpUser?: string;
+    /** HTTP password for basic auth */
+    httpPassword?: string;
+    /** Request headers to set */
+    requestHeaders?: {
+        set?: Record<string, string>;
+    };
+    /** Response headers to set */
+    responseHeaders?: {
+        set?: Record<string, string>;
+    };
+    /** Route by HTTP user */
+    routeByHTTPUser?: string;
+}
+/** HTTPS proxy configuration */
+interface HTTPSProxyConfig extends BaseProxyConfig {
+    type: 'https';
+    /** Custom domain names */
+    customDomains?: string[];
+    /** Subdomain under server's subdomain_host */
+    subdomain?: string;
+}
+/** TCPMUX proxy configuration */
+interface TCPMUXProxyConfig extends BaseProxyConfig {
+    type: 'tcpmux';
+    /** Multiplexer type */
+    multiplexer?: 'httpconnect';
+    /** Custom domain names */
+    customDomains?: string[];
+    /** Subdomain under server's subdomain_host */
+    subdomain?: string;
+    /** Route by HTTP user */
+    routeByHTTPUser?: string;
+    /** HTTP username */
+    httpUser?: string;
+    /** HTTP password */
+    httpPassword?: string;
+}
+/** STCP proxy configuration */
+interface STCPProxyConfig extends BaseProxyConfig {
+    type: 'stcp';
+    /** Secret key shared with visitor */
+    secretKey?: string;
+    /** Allowed visitor users */
+    allowUsers?: string[];
+}
+/** XTCP proxy configuration */
+interface XTCPProxyConfig extends BaseProxyConfig {
+    type: 'xtcp';
+    /** Secret key shared with visitor */
+    secretKey?: string;
+    /** Allowed visitor users */
+    allowUsers?: string[];
+}
+/** SUDP proxy configuration */
+interface SUDPProxyConfig extends BaseProxyConfig {
+    type: 'sudp';
+    /** Secret key shared with visitor */
+    secretKey?: string;
+    /** Allowed visitor users */
+    allowUsers?: string[];
+}
+/** Union type of all proxy configurations */
+type ProxyConfig = TCPProxyConfig | UDPProxyConfig | HTTPProxyConfig | HTTPSProxyConfig | TCPMUXProxyConfig | STCPProxyConfig | XTCPProxyConfig | SUDPProxyConfig;
+/** Visitor type */
+type VisitorType = 'stcp' | 'xtcp' | 'sudp';
+/** Base visitor configuration */
+interface BaseVisitorConfig {
+    /** Visitor name (unique) */
+    name: string;
+    /** Visitor type */
+    type: VisitorType;
+    /** Server name to connect to */
+    serverName: string;
+    /** Secret key shared with proxy */
+    secretKey?: string;
+    /** Local IP to bind */
+    bindAddr?: string;
+    /** Local port to bind */
+    bindPort?: number;
+}
+/** STCP visitor configuration */
+interface STCPVisitorConfig extends BaseVisitorConfig {
+    type: 'stcp';
+}
+/** XTCP visitor configuration */
+interface XTCPVisitorConfig extends BaseVisitorConfig {
+    type: 'xtcp';
+    /** Keep tunnel alive even when no connection */
+    keepTunnelOpen?: boolean;
+    /** Max retries for establishing connection */
+    maxRetriesAnHour?: number;
+    /** Min retry interval (seconds) */
+    minRetryInterval?: number;
+    /** Fallback to STCP when XTCP fails */
+    fallbackTo?: string;
+    /** Fallback timeout (seconds) */
+    fallbackTimeoutMs?: number;
+}
+/** SUDP visitor configuration */
+interface SUDPVisitorConfig extends BaseVisitorConfig {
+    type: 'sudp';
+}
+/** Union type of all visitor configurations */
+type VisitorConfig = STCPVisitorConfig | XTCPVisitorConfig | SUDPVisitorConfig;
+
+export type { AuthClientConfig, AuthMethod, AuthOIDCClientConfig, AuthOIDCServerConfig, AuthScope, AuthServerConfig, BaseProxyConfig, BaseVisitorConfig, ClientCommonConfig, ClientConfig, ClientTransportConfig, ClientTransportProtocol, FileSource, HTTPHeader, HTTPPluginOptions, HTTPProxyConfig, HTTPSProxyConfig, HeaderOperations, LoadBalancerStrategy, LogConfig, LogLevel, NatTraversalConfig, PortsRange, ProxyConfig, ProxyType, QUICOptions, SSHTunnelGateway, STCPProxyConfig, STCPVisitorConfig, SUDPProxyConfig, SUDPVisitorConfig, ServerConfig, ServerTransportConfig, TCPMUXProxyConfig, TCPProxyConfig, TLSClientConfig, TLSConfig, TLSServerConfig, UDPProxyConfig, ValueSource, ValueSourceType, VirtualNetConfig, VisitorConfig, VisitorType, WebServerConfig, XTCPProxyConfig, XTCPVisitorConfig };

package/dist/index.mjs

@@ -0,0 +1 @@
+

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@frp-bridge/types",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "Frp bridge type definitions",
+  "license": "MIT",
+  "homepage": "https://github.com/frp-web/bridge#readme",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:frp-web/bridge.git"
+  },
+  "bugs": {
+    "url": "https://github.com/frp-web/bridge/issues"
+  },
+  "keywords": [
+    "frp",
+    "bridge",
+    "types",
+    "typescript"
+  ],
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "stub": "unbuild --stub",
+    "build": "unbuild"
+  }
+}