xray-typed 1.0.0

package/dist/transport/websocket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.js","sourceRoot":"","sources":["../../src/transport/websocket.ts"],"names":[],"mappings":""}

package/dist/xray-config.d.ts

@@ -0,0 +1,76 @@
+import { LogConfig } from './config/log';
+import { APIConfig } from './config/api';
+import { MetricsConfig } from './config/metrics';
+import { StatsConfig } from './config/stats';
+import { DNSConfig } from './config/dns';
+import { RoutingConfig } from './config/routing';
+import { PolicyConfig } from './config/policy';
+import { ReverseConfig } from './config/reverse';
+import { FakeDNSConfig } from './config/fakedns';
+import { ObservatoryConfig, BurstObservatoryConfig } from './config/observatory';
+import { InboundConfig } from './config/inbound';
+import { OutboundConfig } from './config/outbound';
+/**
+ * Root Xray-Core configuration object.
+ * This is the top-level interface representing the complete xray JSON config file.
+ *
+ * @see https://xtls.github.io/en/config/
+ * @example
+ * ```typescript
+ * import { XrayConfig } from 'xray-typed';
+ *
+ * const config: XrayConfig = {
+ *   log: { loglevel: 'warning' },
+ *   inbounds: [{ protocol: 'vless', port: 443, ... }],
+ *   outbounds: [{ protocol: 'freedom', tag: 'direct' }],
+ *   routing: { rules: [...] }
+ * };
+ * ```
+ */
+export interface XrayConfig {
+    /** Log configuration. */
+    log?: LogConfig;
+    /** gRPC API configuration. */
+    api?: APIConfig;
+    /** Metrics endpoint configuration. */
+    metrics?: MetricsConfig;
+    /** DNS configuration (built-in DNS server). */
+    dns?: DNSConfig;
+    /** Routing rules and balancers. */
+    routing?: RoutingConfig;
+    /** Connection policy settings. */
+    policy?: PolicyConfig;
+    /** Inbound connections. */
+    inbounds?: InboundConfig[];
+    /** Outbound connections. */
+    outbounds?: OutboundConfig[];
+    /** Global transport settings (deprecated, prefer per-inbound/outbound streamSettings). */
+    transport?: Record<string, unknown>;
+    /** Statistics module (presence enables stats). */
+    stats?: StatsConfig;
+    /** Reverse proxy configuration (bridge/portal). */
+    reverse?: ReverseConfig;
+    /** Fake DNS configuration. */
+    fakeDns?: FakeDNSConfig;
+    /** Observatory configuration for outbound health monitoring. */
+    observatory?: ObservatoryConfig;
+    /** Burst Observatory configuration for outbound health monitoring. */
+    burstObservatory?: BurstObservatoryConfig;
+    /** Version configuration. */
+    version?: VersionConfig;
+}
+/**
+ * Version constraint configuration.
+ * Prevents running a config on an incompatible Xray-Core version.
+ * Both fields are optional — omitted or empty means no constraint.
+ * Versions follow Xray's x.y.z syntax (e.g. "25.8.3").
+ *
+ * @since Xray-Core 25.8.3
+ */
+export interface VersionConfig {
+    /** Minimum required Xray-Core version (e.g. "25.8.3"). Empty or omitted = no lower bound. */
+    min?: string;
+    /** Maximum allowed Xray-Core version. Empty or omitted = no upper bound. */
+    max?: string;
+}
+//# sourceMappingURL=xray-config.d.ts.map

package/dist/xray-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xray-config.d.ts","sourceRoot":"","sources":["../src/xray-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,UAAU;IACvB,yBAAyB;IACzB,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,8BAA8B;IAC9B,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,sCAAsC;IACtC,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,+CAA+C;IAC/C,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,mCAAmC;IACnC,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,kCAAkC;IAClC,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;IAC3B,4BAA4B;IAC5B,SAAS,CAAC,EAAE,cAAc,EAAE,CAAC;IAC7B,0FAA0F;IAC1F,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,kDAAkD;IAClD,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,mDAAmD;IACnD,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,8BAA8B;IAC9B,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,gEAAgE;IAChE,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAC1C,6BAA6B;IAC7B,OAAO,CAAC,EAAE,aAAa,CAAC;CAC3B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa;IAC1B,6FAA6F;IAC7F,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,4EAA4E;IAC5E,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB"}

package/dist/xray-config.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=xray-config.js.map

package/dist/xray-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xray-config.js","sourceRoot":"","sources":["../src/xray-config.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "xray-typed",
+  "version": "1.0.0",
+  "description": "Complete TypeScript type definitions for Xray-Core JSON configuration",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepublish": "rm -rf build && tsc",
+    "build": "tsc"
+  },
+  "keywords": [
+    "xray",
+    "xray-core",
+    "xtls",
+    "vless",
+    "vmess",
+    "trojan",
+    "shadowsocks",
+    "proxy",
+    "typescript",
+    "types"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}