@herbertgao/surgio/build/validators/vmess.d.ts

Generating rules for Surge, Clash, Quantumult like a PRO

import { z } from 'zod';
import { NodeTypeEnum } from '../types';
export declare const VmessNetworkValidator: z.ZodUnion<[z.ZodLiteral<"tcp">, z.ZodLiteral<"ws">, z.ZodLiteral<"h2">, z.ZodLiteral<"http">, z.ZodLiteral<"grpc">, z.ZodLiteral<"quic">, z.ZodLiteral<"httpupgrade">]>;
export declare const VmessMethodValidator: z.ZodUnion<[z.ZodLiteral<"none">, z.ZodLiteral<"aes-128-gcm">, z.ZodLiteral<"chacha20-poly1305">, z.ZodLiteral<"auto">]>;
export declare const VmessWSOptsValidator: z.ZodObject<{
    path: z.ZodString;
    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
}, "strip", z.ZodTypeAny, {
    path: string;
    headers?: Record<string, string> | undefined;
}, {
    path: string;
    headers?: Record<string, string> | undefined;
}>;
export declare const VmessH2OptsValidator: z.ZodObject<{
    path: z.ZodString;
    host: z.ZodArray<z.ZodString, "atleastone">;
}, "strip", z.ZodTypeAny, {
    host: [string, ...string[]];
    path: string;
}, {
    host: [string, ...string[]];
    path: string;
}>;
export declare const VmessHttpOptsValidator: z.ZodObject<{
    path: z.ZodArray<z.ZodString, "many">;
    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
    method: z.ZodDefault<z.ZodOptional<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
    path: string[];
    method: string;
    headers?: Record<string, string> | undefined;
}, {
    path: string[];
    headers?: Record<string, string> | undefined;
    method?: string | undefined;
}>;
export declare const VmessGRPCOptsValidator: z.ZodObject<{
    serviceName: z.ZodString;
}, "strip", z.ZodTypeAny, {
    serviceName: string;
}, {
    serviceName: string;
}>;
export declare const VmessQuicOptsValidator: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
export declare const VmessHttpUpgradeOptsValidator: z.ZodObject<{
    path: z.ZodString;
    host: z.ZodOptional<z.ZodString>;
    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
}, "strip", z.ZodTypeAny, {
    path: string;
    host?: string | undefined;
    headers?: Record<string, string> | undefined;
}, {
    path: string;
    host?: string | undefined;
    headers?: Record<string, string> | undefined;
}>;
/**
 * @see https://stash.wiki/proxy-protocols/proxy-types#vmess
 * @see https://wiki.metacubex.one/config/proxies/vmess/
 */
export declare const VmessNodeConfigValidator: z.ZodObject<{
    nodeName: z.ZodString;
    enable: z.ZodOptional<z.ZodBoolean>;
    tfo: z.ZodOptional<z.ZodBoolean>;
    mptcp: z.ZodOptional<z.ZodBoolean>;
    ecn: z.ZodOptional<z.ZodBoolean>;
    shadowTls: z.ZodOptional<z.ZodObject<{
        version: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, string | number, string | number>>;
        password: z.ZodString;
        sni: z.ZodString;
    }, "strip", z.ZodTypeAny, {
        password: string;
        sni: string;
        version?: string | number | undefined;
    }, {
        password: string;
        sni: string;
        version?: string | number | undefined;
    }>>;
    blockQuic: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"auto">, z.ZodLiteral<"on">, z.ZodLiteral<"off">]>>;
    portHopping: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
    portHoppingInterval: z.ZodOptional<z.ZodNumber>;
    underlyingProxy: z.ZodOptional<z.ZodString>;
    testUrl: z.ZodOptional<z.ZodString>;
    testTimeout: z.ZodOptional<z.ZodNumber>;
    surgeConfig: z.ZodOptional<z.ZodObject<{
        resolveHostname: z.ZodOptional<z.ZodBoolean>;
        vmessAEAD: z.ZodOptional<z.ZodBoolean>;
    }, "strip", z.ZodTypeAny, {
        resolveHostname?: boolean | undefined;
        vmessAEAD?: boolean | undefined;
    }, {
        resolveHostname?: boolean | undefined;
        vmessAEAD?: boolean | undefined;
    }>>;
    surfboardConfig: z.ZodOptional<z.ZodObject<{
        vmessAEAD: z.ZodOptional<z.ZodBoolean>;
    }, "strip", z.ZodTypeAny, {
        vmessAEAD?: boolean | undefined;
    }, {
        vmessAEAD?: boolean | undefined;
    }>>;
    quantumultXConfig: z.ZodOptional<z.ZodObject<{
        vmessAEAD: z.ZodOptional<z.ZodBoolean>;
    }, "strip", z.ZodTypeAny, {
        vmessAEAD?: boolean | undefined;
    }, {
        vmessAEAD?: boolean | undefined;
    }>>;
    clashConfig: z.ZodOptional<z.ZodObject<{
        enableTuic: z.ZodOptional<z.ZodBoolean>;
        enableShadowTls: z.ZodOptional<z.ZodBoolean>;
        enableHysteria2: z.ZodOptional<z.ZodBoolean>;
        enableVless: z.ZodOptional<z.ZodBoolean>;
        clashCore: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"clash">, z.ZodLiteral<"clash.meta">, z.ZodLiteral<"stash">]>>;
    }, "strip", z.ZodTypeAny, {
        enableTuic?: boolean | undefined;
        enableShadowTls?: boolean | undefined;
        enableHysteria2?: boolean | undefined;
        enableVless?: boolean | undefined;
        clashCore?: "clash" | "clash.meta" | "stash" | undefined;
    }, {
        enableTuic?: boolean | undefined;
        enableShadowTls?: boolean | undefined;
        enableHysteria2?: boolean | undefined;
        enableVless?: boolean | undefined;
        clashCore?: "clash" | "clash.meta" | "stash" | undefined;
    }>>;
    hostnameIp: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString, "many">>>;
    binPath: z.ZodOptional<z.ZodString>;
    localPort: z.ZodOptional<z.ZodNumber>;
    interfaceName: z.ZodOptional<z.ZodString>;
    ipVersion: z.ZodOptional<z.ZodString>;
} & {
    type: z.ZodLiteral<NodeTypeEnum.Vmess>;
    hostname: z.ZodString;
    port: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, string | number, string | number>;
    method: z.ZodUnion<[z.ZodLiteral<"none">, z.ZodLiteral<"aes-128-gcm">, z.ZodLiteral<"chacha20-poly1305">, z.ZodLiteral<"auto">]>;
    uuid: z.ZodString;
    alterId: z.ZodOptional<z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, string | number, string | number>>>;
    network: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"tcp">, z.ZodLiteral<"ws">, z.ZodLiteral<"h2">, z.ZodLiteral<"http">, z.ZodLiteral<"grpc">, z.ZodLiteral<"quic">, z.ZodLiteral<"httpupgrade">]>>;
    udpRelay: z.ZodOptional<z.ZodBoolean>;
    wsOpts: z.ZodOptional<z.ZodObject<{
        path: z.ZodString;
        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
    }, "strip", z.ZodTypeAny, {
        path: string;
        headers?: Record<string, string> | undefined;
    }, {
        path: string;
        headers?: Record<string, string> | undefined;
    }>>;
    h2Opts: z.ZodOptional<z.ZodObject<{
        path: z.ZodString;
        host: z.ZodArray<z.ZodString, "atleastone">;
    }, "strip", z.ZodTypeAny, {
        host: [string, ...string[]];
        path: string;
    }, {
        host: [string, ...string[]];
        path: string;
    }>>;
    httpOpts: z.ZodOptional<z.ZodObject<{
        path: z.ZodArray<z.ZodString, "many">;
        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
        method: z.ZodDefault<z.ZodOptional<z.ZodString>>;
    }, "strip", z.ZodTypeAny, {
        path: string[];
        method: string;
        headers?: Record<string, string> | undefined;
    }, {
        path: string[];
        headers?: Record<string, string> | undefined;
        method?: string | undefined;
    }>>;
    grpcOpts: z.ZodOptional<z.ZodObject<{
        serviceName: z.ZodString;
    }, "strip", z.ZodTypeAny, {
        serviceName: string;
    }, {
        serviceName: string;
    }>>;
    quicOpts: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
    httpUpgradeOpts: z.ZodOptional<z.ZodObject<{
        path: z.ZodString;
        host: z.ZodOptional<z.ZodString>;
        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
    }, "strip", z.ZodTypeAny, {
        path: string;
        host?: string | undefined;
        headers?: Record<string, string> | undefined;
    }, {
        path: string;
        host?: string | undefined;
        headers?: Record<string, string> | undefined;
    }>>;
    tls: z.ZodOptional<z.ZodBoolean>;
    sni: z.ZodOptional<z.ZodString>;
    tls13: z.ZodOptional<z.ZodBoolean>;
    skipCertVerify: z.ZodOptional<z.ZodBoolean>;
    serverCertFingerprintSha256: z.ZodOptional<z.ZodString>;
    alpn: z.ZodOptional<z.ZodArray<z.ZodString, "atleastone">>;
    clientFingerprint: z.ZodOptional<z.ZodString>;
    multiplex: z.ZodOptional<z.ZodObject<{
        protocol: z.ZodEnum<["smux", "yamux", "h2mux"]>;
        maxConnections: z.ZodOptional<z.ZodNumber>;
        minStreams: z.ZodOptional<z.ZodNumber>;
        maxStreams: z.ZodOptional<z.ZodNumber>;
        padding: z.ZodOptional<z.ZodBoolean>;
        brutal: z.ZodOptional<z.ZodObject<{
            upMbps: z.ZodNumber;
            downMbps: z.ZodNumber;
        }, "strip", z.ZodTypeAny, {
            upMbps: number;
            downMbps: number;
        }, {
            upMbps: number;
            downMbps: number;
        }>>;
    }, "strip", z.ZodTypeAny, {
        protocol: "smux" | "yamux" | "h2mux";
        maxConnections?: number | undefined;
        minStreams?: number | undefined;
        maxStreams?: number | undefined;
        padding?: boolean | undefined;
        brutal?: {
            upMbps: number;
            downMbps: number;
        } | undefined;
    }, {
        protocol: "smux" | "yamux" | "h2mux";
        maxConnections?: number | undefined;
        minStreams?: number | undefined;
        maxStreams?: number | undefined;
        padding?: boolean | undefined;
        brutal?: {
            upMbps: number;
            downMbps: number;
        } | undefined;
    }>>;
    host: z.ZodOptional<z.ZodString>;
    path: z.ZodOptional<z.ZodString>;
    wsHeaders: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
}, "strip", z.ZodTypeAny, {
    port: string | number;
    type: NodeTypeEnum.Vmess;
    nodeName: string;
    hostname: string;
    method: "auto" | "none" | "aes-128-gcm" | "chacha20-poly1305";
    uuid: string;
    network: "tcp" | "http" | "ws" | "h2" | "grpc" | "quic" | "httpupgrade";
    host?: string | undefined;
    path?: string | undefined;
    enable?: boolean | undefined;
    tfo?: boolean | undefined;
    mptcp?: boolean | undefined;
    ecn?: boolean | undefined;
    sni?: string | undefined;
    shadowTls?: {
        password: string;
        sni: string;
        version?: string | number | undefined;
    } | undefined;
    blockQuic?: "auto" | "on" | "off" | undefined;
    portHopping?: string | undefined;
    portHoppingInterval?: number | undefined;
    underlyingProxy?: string | undefined;
    testUrl?: string | undefined;
    testTimeout?: number | undefined;
    surgeConfig?: {
        resolveHostname?: boolean | undefined;
        vmessAEAD?: boolean | undefined;
    } | undefined;
    surfboardConfig?: {
        vmessAEAD?: boolean | undefined;
    } | undefined;
    quantumultXConfig?: {
        vmessAEAD?: boolean | undefined;
    } | undefined;
    clashConfig?: {
        enableTuic?: boolean | undefined;
        enableShadowTls?: boolean | undefined;
        enableHysteria2?: boolean | undefined;
        enableVless?: boolean | undefined;
        clashCore?: "clash" | "clash.meta" | "stash" | undefined;
    } | undefined;
    hostnameIp?: readonly string[] | undefined;
    binPath?: string | undefined;
    localPort?: number | undefined;
    interfaceName?: string | undefined;
    ipVersion?: string | undefined;
    tls13?: boolean | undefined;
    skipCertVerify?: boolean | undefined;
    alpn?: [string, ...string[]] | undefined;
    serverCertFingerprintSha256?: string | undefined;
    clientFingerprint?: string | undefined;
    udpRelay?: boolean | undefined;
    tls?: boolean | undefined;
    wsHeaders?: Record<string, string> | undefined;
    multiplex?: {
        protocol: "smux" | "yamux" | "h2mux";
        maxConnections?: number | undefined;
        minStreams?: number | undefined;
        maxStreams?: number | undefined;
        padding?: boolean | undefined;
        brutal?: {
            upMbps: number;
            downMbps: number;
        } | undefined;
    } | undefined;
    alterId?: string | number | undefined;
    wsOpts?: {
        path: string;
        headers?: Record<string, string> | undefined;
    } | undefined;
    h2Opts?: {
        host: [string, ...string[]];
        path: string;
    } | undefined;
    httpOpts?: {
        path: string[];
        method: string;
        headers?: Record<string, string> | undefined;
    } | undefined;
    grpcOpts?: {
        serviceName: string;
    } | undefined;
    quicOpts?: {} | undefined;
    httpUpgradeOpts?: {
        path: string;
        host?: string | undefined;
        headers?: Record<string, string> | undefined;
    } | undefined;
}, {
    port: string | number;
    type: NodeTypeEnum.Vmess;
    nodeName: string;
    hostname: string;
    method: "auto" | "none" | "aes-128-gcm" | "chacha20-poly1305";
    uuid: string;
    host?: string | undefined;
    path?: string | undefined;
    enable?: boolean | undefined;
    tfo?: boolean | undefined;
    mptcp?: boolean | undefined;
    ecn?: boolean | undefined;
    sni?: string | undefined;
    shadowTls?: {
        password: string;
        sni: string;
        version?: string | number | undefined;
    } | undefined;
    blockQuic?: "auto" | "on" | "off" | undefined;
    portHopping?: string | undefined;
    portHoppingInterval?: number | undefined;
    underlyingProxy?: string | undefined;
    testUrl?: string | undefined;
    testTimeout?: number | undefined;
    surgeConfig?: {
        resolveHostname?: boolean | undefined;
        vmessAEAD?: boolean | undefined;
    } | undefined;
    surfboardConfig?: {
        vmessAEAD?: boolean | undefined;
    } | undefined;
    quantumultXConfig?: {
        vmessAEAD?: boolean | undefined;
    } | undefined;
    clashConfig?: {
        enableTuic?: boolean | undefined;
        enableShadowTls?: boolean | undefined;
        enableHysteria2?: boolean | undefined;
        enableVless?: boolean | undefined;
        clashCore?: "clash" | "clash.meta" | "stash" | undefined;
    } | undefined;
    hostnameIp?: readonly string[] | undefined;
    binPath?: string | undefined;
    localPort?: number | undefined;
    interfaceName?: string | undefined;
    ipVersion?: string | undefined;
    tls13?: boolean | undefined;
    skipCertVerify?: boolean | undefined;
    alpn?: [string, ...string[]] | undefined;
    serverCertFingerprintSha256?: string | undefined;
    clientFingerprint?: string | undefined;
    udpRelay?: boolean | undefined;
    tls?: boolean | undefined;
    wsHeaders?: Record<string, string> | undefined;
    multiplex?: {
        protocol: "smux" | "yamux" | "h2mux";
        maxConnections?: number | undefined;
        minStreams?: number | undefined;
        maxStreams?: number | undefined;
        padding?: boolean | undefined;
        brutal?: {
            upMbps: number;
            downMbps: number;
        } | undefined;
    } | undefined;
    alterId?: string | number | undefined;
    network?: "tcp" | "http" | "ws" | "h2" | "grpc" | "quic" | "httpupgrade" | undefined;
    wsOpts?: {
        path: string;
        headers?: Record<string, string> | undefined;
    } | undefined;
    h2Opts?: {
        host: [string, ...string[]];
        path: string;
    } | undefined;
    httpOpts?: {
        path: string[];
        headers?: Record<string, string> | undefined;
        method?: string | undefined;
    } | undefined;
    grpcOpts?: {
        serviceName: string;
    } | undefined;
    quicOpts?: {} | undefined;
    httpUpgradeOpts?: {
        path: string;
        host?: string | undefined;
        headers?: Record<string, string> | undefined;
    } | undefined;
}>;