xray-configurator — API

ExampleConfig

src/domain/exampleCatalog.generated.ts

export type ExampleConfig = Record<string, unknown>;

ExampleCatalogItem

src/domain/exampleCatalog.generated.ts

export interface ExampleCatalogItem {
    id: string;
    title: string;
    path: string;
    role: 'server' | 'client' | 'mixed' | 'other';
    protocols: string[];
    transports: string[];
    securities: string[];
    features: string[];
    raw: string;
    config: ExampleConfig | null;
}

ConfigPreset

src/domain/presets.ts

export interface ConfigPreset {
    id: string;
    label: string;
    labelRu: string;
    description: string;
    descriptionRu: string;
    create: () => XrayConfig;
}

ValidationSeverity

src/domain/validation.ts

export type ValidationSeverity = 'error' | 'warning';

ValidationIssue

src/domain/validation.ts

export interface ValidationIssue {
    path: string;
    severity: ValidationSeverity;
    message: string;
    messageRu: string;
}

validateConfig

src/domain/validation.ts

export function validateConfig(config: XrayConfig): ValidationIssue[]

Language

src/domain/xray.ts

export type Language = 'en' | 'ru';

JsonValue

src/domain/xray.ts

export type JsonValue = string | number | boolean | null | JsonValue[] | { [key: string]: JsonValue };

XrayConfig

src/domain/xray.ts

export interface XrayConfig {
    log?: Record<string, JsonValue>;
    api?: Record<string, JsonValue>;
    dns?: Record<string, JsonValue>;
    routing?: Record<string, JsonValue>;
    policy?: Record<string, JsonValue>;
    inbounds?: InboundConfig[];
    outbounds?: OutboundConfig[];
    stats?: Record<string, JsonValue>;
    fakeDns?: Record<string, JsonValue>;
    metrics?: Record<string, JsonValue>;
    observatory?: Record<string, JsonValue>;
    burstObservatory?: Record<string, JsonValue>;
    geodata?: Record<string, JsonValue>;
    version?: Record<string, JsonValue>;
}

InboundConfig

src/domain/xray.ts

export interface InboundConfig {
    tag: string;
    listen?: string;
    port?: number | string;
    protocol: InboundProtocol;
    settings: Record<string, JsonValue>;
    streamSettings?: StreamSettings;
    sniffing?: Record<string, JsonValue>;
}

OutboundConfig

src/domain/xray.ts

export interface OutboundConfig {
    tag: string;
    protocol: OutboundProtocol;
    settings: Record<string, JsonValue>;
    sendThrough?: string;
    targetStrategy?: string;
    streamSettings?: StreamSettings;
    proxySettings?: Record<string, JsonValue>;
    mux?: Record<string, JsonValue>;
}

InboundProtocol

src/domain/xray.ts

export type InboundProtocol =
    | 'vless'
    | 'vmess'
    | 'trojan'
    | 'shadowsocks'
    | 'socks'
    | 'mixed'
    | 'http'
    | 'dokodemo-door'
    | 'wireguard'
    | 'hysteria'
    | 'tun';

OutboundProtocol

src/domain/xray.ts

export type OutboundProtocol =
    | 'freedom'
    | 'blackhole'
    | 'dns'
    | 'vless'
    | 'vmess'
    | 'trojan'
    | 'shadowsocks'
    | 'socks'
    | 'http'
    | 'wireguard'
    | 'hysteria'
    | 'loopback';

TransportProtocol

src/domain/xray.ts

export type TransportProtocol =
    'raw'
    | 'tcp'
    | 'ws'
    | 'grpc'
    | 'xhttp'
    | 'splithttp'
    | 'kcp'
    | 'httpupgrade'
    | 'hysteria';

SecurityProtocol

src/domain/xray.ts

export type SecurityProtocol = 'none' | 'tls' | 'reality';

StreamSettings

src/domain/xray.ts

export interface StreamSettings {
    network?: TransportProtocol;
    security?: SecurityProtocol;
    tcpSettings?: Record<string, JsonValue>;
    rawSettings?: Record<string, JsonValue>;
    wsSettings?: Record<string, JsonValue>;
    grpcSettings?: Record<string, JsonValue>;
    xhttpSettings?: Record<string, JsonValue>;
    splithttpSettings?: Record<string, JsonValue>;
    kcpSettings?: Record<string, JsonValue>;
    httpupgradeSettings?: Record<string, JsonValue>;
    hysteriaSettings?: Record<string, JsonValue>;
    tlsSettings?: Record<string, JsonValue>;
    realitySettings?: Record<string, JsonValue>;
    sockopt?: Record<string, JsonValue>;
}

FieldDefinition

src/domain/xray.ts

export interface FieldDefinition {
    key: string;
    label: string;
    labelRu: string;
    help: string;
    helpRu: string;
    kind: 'text' | 'number' | 'switch' | 'select' | 'tags' | 'textarea' | 'json' | 'password';
    options?: string[];
    placeholder?: string;
    secret?: boolean;
}

ProtocolDefinition

src/domain/xray.ts

export interface ProtocolDefinition {
    value: string;
    label: string;
    server: boolean;
    help: string;
    helpRu: string;
    fields: FieldDefinition[];
    defaultSettings: Record<string, JsonValue>;
}

field

src/domain/xray.ts

export function field(
    key: string,
    label: string,
    labelRu: string,
    help: string,
    helpRu: string,
    kind: FieldDefinition['kind'],
    options?: string[],
    placeholder?: string,
): FieldDefinition

randomHex

src/domain/xray.ts

export function randomHex(bytes: number): string

randomBase64Url

src/domain/xray.ts

export function randomBase64Url(bytes: number): string

randomToken

src/domain/xray.ts

export function randomToken(bytes = 18): string

pruneEmpty

src/domain/xray.ts

export function pruneEmpty(value: JsonValue): JsonValue | undefined

getProtocol

src/domain/xray.ts

export function getProtocol<T extends ProtocolDefinition>(items: T[], value: string): T