nodelistparser 0.1.4 → 0.3.0

package/dist/cjs/index.d.ts

@@ -57,8 +57,14 @@ interface TuicConfig extends SharedConfigBase {
     sni: string;
     uuid: string;
     alpn: string;
+    token: string;
+}
+interface TuicV5Config extends SharedConfigBase, TlsSharedConfig {
+    type: 'tuic-v5';
+    sni: string;
+    uuid: string;
+    alpn: string;
     password: string;
-    version: number;
 }
 interface Socks5Config extends SharedConfigBase {
     type: 'socks5';
@@ -87,16 +93,16 @@ interface Hysteria2Config extends SharedConfigBase, Omit<TlsSharedConfig, 'sni'>
     /** port hopping interval */
     portHoppingInterval?: number;
 }
-type SupportedConfig = HttpProxyConfig | SnellConfig | TrojanConfig | ShadowSocksConfig | TuicConfig | Socks5Config | VmessConfig | Hysteria2Config;
+type SupportedConfig = HttpProxyConfig | SnellConfig | TrojanConfig | ShadowSocksConfig | TuicConfig | TuicV5Config | Socks5Config | VmessConfig | Hysteria2Config;
 
 declare function decode$1(raw: string): SupportedConfig;
 declare function encode$1(config: SupportedConfig): string;
 
-declare namespace index$2 {
+declare namespace index$3 {
   export { decode$1 as decode, encode$1 as encode };
 }
 
-declare function decode(config: any): SupportedConfig;
+declare function decode(config: Record<string, any>): SupportedConfig;
 declare function encode(config: SupportedConfig): {
     tfo: boolean | undefined;
     plugin?: string | undefined;
@@ -146,6 +152,8 @@ declare function encode(config: SupportedConfig): {
     down?: undefined;
 } | {
     tfo: boolean | undefined;
+    udp: boolean;
+    token: string;
     name: string;
     type: string;
     server: string;
@@ -153,9 +161,6 @@ declare function encode(config: SupportedConfig): {
     sni: string;
     uuid: string;
     alpn: string[];
-    token: string;
-    version: number;
-    udp: boolean;
     alterId?: undefined;
     tls?: undefined;
     servername?: undefined;
@@ -168,6 +173,28 @@ declare function encode(config: SupportedConfig): {
     password?: undefined;
     down?: undefined;
     'skip-cert-verify'?: undefined;
+} | {
+    tfo: boolean | undefined;
+    udp: boolean;
+    password: string;
+    name: string;
+    type: string;
+    server: string;
+    port: number;
+    sni: string;
+    uuid: string;
+    alpn: string[];
+    alterId?: undefined;
+    tls?: undefined;
+    servername?: undefined;
+    'ws-path'?: undefined;
+    'ws-headers'?: undefined;
+    cipher?: undefined;
+    'ws-opts'?: undefined;
+    network?: undefined;
+    ports?: undefined;
+    down?: undefined;
+    'skip-cert-verify'?: undefined;
 } | {
     tfo: boolean | undefined;
     name: string;
@@ -253,21 +280,28 @@ declare function encode(config: SupportedConfig): {
     network?: undefined;
 };
 
-declare const index$1_decode: typeof decode;
-declare const index$1_encode: typeof encode;
-declare namespace index$1 {
-  export { index$1_decode as decode, index$1_encode as encode };
+declare const index$2_decode: typeof decode;
+declare const index$2_encode: typeof encode;
+declare namespace index$2 {
+  export { index$2_decode as decode, index$2_encode as encode };
 }
 
 declare function decodeOne(sip002: string): ShadowSocksConfig;
 declare function decodeBase64Multiline(text: string): string[];
 declare function decodeMultiline(text: string): ShadowSocksConfig[];
 
-declare const index_decodeBase64Multiline: typeof decodeBase64Multiline;
-declare const index_decodeMultiline: typeof decodeMultiline;
-declare const index_decodeOne: typeof decodeOne;
+declare const index$1_decodeBase64Multiline: typeof decodeBase64Multiline;
+declare const index$1_decodeMultiline: typeof decodeMultiline;
+declare const index$1_decodeOne: typeof decodeOne;
+declare namespace index$1 {
+  export { index$1_decodeBase64Multiline as decodeBase64Multiline, index$1_decodeMultiline as decodeMultiline, index$1_decodeOne as decodeOne };
+}
+
+declare function parse(line: string): TrojanConfig;
+
+declare const index_parse: typeof parse;
 declare namespace index {
-  export { index_decodeBase64Multiline as decodeBase64Multiline, index_decodeMultiline as decodeMultiline, index_decodeOne as decodeOne };
+  export { index_parse as parse };
 }
 
-export { type HttpProxyConfig, type Hysteria2Config, type ShadowSocksConfig, type SharedConfigBase, type SnellConfig, type Socks5Config, type SupportedConfig, type TrojanBasicConfig, type TrojanConfig, type TuicConfig, type VmessConfig, index$1 as clash, index as ss, index$2 as surge };
+export { type HttpProxyConfig, type Hysteria2Config, type ShadowSocksConfig, type SharedConfigBase, type SnellConfig, type Socks5Config, type SupportedConfig, type TrojanBasicConfig, type TrojanConfig, type TuicConfig, type TuicV5Config, type VmessConfig, index$2 as clash, index$1 as ss, index$3 as surge, index as trojan };

package/dist/cjs/index.js

@@ -46,7 +46,8 @@ const strKeys = new Set([
     'block-quic',
     'ws-path',
     'ws-headers',
-    'port-hopping'
+    'port-hopping',
+    'token'
 ]);
 const isProxyStrKey = (key)=>strKeys.has(key);
 const UNSUPPORTED_VALUE = Symbol('unsupported');
@@ -143,8 +144,19 @@ function decode$1(raw) {
                     sni: restDetails.sni,
                     uuid: restDetails.uuid,
                     alpn: restDetails.alpn,
+                    token: restDetails.token,
+                    ...shared
+                };
+            }
+        case 'tuic-v5':
+            {
+                return {
+                    type: 'tuic-v5',
+                    uuid: restDetails.uuid,
+                    alpn: restDetails.alpn,
                     password: restDetails.password,
-                    version: restDetails.version,
+                    sni: restDetails.sni,
+                    skipCertVerify: restDetails['skip-cert-verify'],
                     ...shared
                 };
             }
@@ -232,7 +244,7 @@ function encode$1(config) {
             ]);
         case 'tuic':
             return joinString([
-                `${config.name} = tuic, ${config.server}, ${config.port}, sni=${config.sni}, uuid=${config.uuid}, alpn=${config.alpn}, password=${config.password}, version=${config.version}`,
+                `${config.name} = tuic, ${config.server}, ${config.port}, sni=${config.sni}, uuid=${config.uuid}, alpn=${config.alpn}, token=${config.token}`,
                 ...shared
             ]);
         case 'socks5':
@@ -270,12 +282,22 @@ function encode$1(config) {
                 `skip-cert-verify=${config.skipCertVerify}`,
                 ...shared
             ]);
+        case 'tuic-v5':
+            return joinString([
+                `${config.name} = tuic-v5, ${config.server}, ${config.port}`,
+                `password=${config.password}`,
+                `uuid=${config.uuid}`,
+                `alpn=${config.alpn}`,
+                `skip-cert-verify=${config.skipCertVerify}`,
+                `sni=${config.sni}`,
+                ...shared
+            ]);
         default:
             guard.never(config, 'type (clash encode)');
     }
 }
 
-var index$2 = {
+var index$3 = {
   __proto__: null,
   decode: decode$1,
   encode: encode$1
@@ -390,6 +412,7 @@ function encode(config) {
                 ...shared
             };
         case 'tuic':
+        case 'tuic-v5':
             return {
                 name: config.name,
                 type: 'tuic',
@@ -398,8 +421,11 @@ function encode(config) {
                 sni: config.sni,
                 uuid: config.uuid,
                 alpn: config.alpn.split(',').map((x)=>x.trim()),
-                token: config.password,
-                version: config.version,
+                ...config.type === 'tuic' ? {
+                    token: config.token
+                } : {
+                    password: config.password
+                },
                 udp: true,
                 ...shared
             };
@@ -467,7 +493,7 @@ function parseStringToObject(input) {
     }, {});
 }
 
-var index$1 = {
+var index$2 = {
   __proto__: null,
   decode: decode,
   encode: encode
@@ -488,8 +514,22 @@ function decodeOne(sip002) {
     }
     const [serverName, _1] = server.split(':');
     const [_2, encodedName] = _1.split('#');
-    const [port, _plugins] = _2.split('/');
-    // TODO: implement plugin parsing
+    const [port, pluginsStr] = _2.split('/');
+    let plugin = null;
+    if (pluginsStr) {
+        try {
+            plugin = new URLSearchParams(pluginsStr).get('plugin');
+        } catch (e) {
+            const err = new Error(`[ss.decodeOne] Invalid plugins: ${pluginsStr}`);
+            err.cause = e;
+            throw err;
+        }
+    }
+    const pluginArgs = (plugin?.split(';') ?? []).reduce((acc, cur)=>{
+        const [key, value] = cur.split('=');
+        acc[key] = value;
+        return acc;
+    }, {});
     return {
         raw: sip002,
         type: 'ss',
@@ -498,7 +538,9 @@ function decodeOne(sip002) {
         port: number(port),
         cipher,
         password,
-        udp: true
+        udp: true,
+        obfs: 'obfs-local' in pluginArgs && 'obfs' in pluginArgs && (pluginArgs.obfs === 'http' || pluginArgs.obfs === 'tls') ? pluginArgs.obfs : undefined,
+        obfsHost: 'obfs-host' in pluginArgs ? pluginArgs['obfs-host'] : undefined
     };
 }
 function decodeBase64Multiline(text) {
@@ -508,13 +550,42 @@ function decodeMultiline(text) {
     return decodeBase64Multiline(text).map((line)=>decodeOne(line));
 }
 
-var index = {
+var index$1 = {
   __proto__: null,
   decodeBase64Multiline: decodeBase64Multiline,
   decodeMultiline: decodeMultiline,
   decodeOne: decodeOne
 };
 
-exports.clash = index$1;
-exports.ss = index;
-exports.surge = index$2;
+function parse(line) {
+    const url = new URL(line);
+    // trojan://password@remote_host:remote_port
+    const password = url.username;
+    const server = url.hostname;
+    const port = Number.parseInt(url.port, 10);
+    if (Number.isNaN(port)) {
+        throw new TypeError('invalid port: ' + url.port);
+    }
+    const name = decodeURIComponent(url.hash.slice(1));
+    return {
+        raw: line,
+        name,
+        type: 'trojan',
+        server,
+        port,
+        password,
+        udp: true,
+        sni: url.searchParams.get('sni') ?? server,
+        skipCertVerify: true
+    };
+}
+
+var index = {
+  __proto__: null,
+  parse: parse
+};
+
+exports.clash = index$2;
+exports.ss = index$1;
+exports.surge = index$3;
+exports.trojan = index;

package/dist/es/index.d.mts

@@ -57,8 +57,14 @@ interface TuicConfig extends SharedConfigBase {
     sni: string;
     uuid: string;
     alpn: string;
+    token: string;
+}
+interface TuicV5Config extends SharedConfigBase, TlsSharedConfig {
+    type: 'tuic-v5';
+    sni: string;
+    uuid: string;
+    alpn: string;
     password: string;
-    version: number;
 }
 interface Socks5Config extends SharedConfigBase {
     type: 'socks5';
@@ -87,16 +93,16 @@ interface Hysteria2Config extends SharedConfigBase, Omit<TlsSharedConfig, 'sni'>
     /** port hopping interval */
     portHoppingInterval?: number;
 }
-type SupportedConfig = HttpProxyConfig | SnellConfig | TrojanConfig | ShadowSocksConfig | TuicConfig | Socks5Config | VmessConfig | Hysteria2Config;
+type SupportedConfig = HttpProxyConfig | SnellConfig | TrojanConfig | ShadowSocksConfig | TuicConfig | TuicV5Config | Socks5Config | VmessConfig | Hysteria2Config;
 
 declare function decode$1(raw: string): SupportedConfig;
 declare function encode$1(config: SupportedConfig): string;
 
-declare namespace index$2 {
+declare namespace index$3 {
   export { decode$1 as decode, encode$1 as encode };
 }
 
-declare function decode(config: any): SupportedConfig;
+declare function decode(config: Record<string, any>): SupportedConfig;
 declare function encode(config: SupportedConfig): {
     tfo: boolean | undefined;
     plugin?: string | undefined;
@@ -146,6 +152,8 @@ declare function encode(config: SupportedConfig): {
     down?: undefined;
 } | {
     tfo: boolean | undefined;
+    udp: boolean;
+    token: string;
     name: string;
     type: string;
     server: string;
@@ -153,9 +161,6 @@ declare function encode(config: SupportedConfig): {
     sni: string;
     uuid: string;
     alpn: string[];
-    token: string;
-    version: number;
-    udp: boolean;
     alterId?: undefined;
     tls?: undefined;
     servername?: undefined;
@@ -168,6 +173,28 @@ declare function encode(config: SupportedConfig): {
     password?: undefined;
     down?: undefined;
     'skip-cert-verify'?: undefined;
+} | {
+    tfo: boolean | undefined;
+    udp: boolean;
+    password: string;
+    name: string;
+    type: string;
+    server: string;
+    port: number;
+    sni: string;
+    uuid: string;
+    alpn: string[];
+    alterId?: undefined;
+    tls?: undefined;
+    servername?: undefined;
+    'ws-path'?: undefined;
+    'ws-headers'?: undefined;
+    cipher?: undefined;
+    'ws-opts'?: undefined;
+    network?: undefined;
+    ports?: undefined;
+    down?: undefined;
+    'skip-cert-verify'?: undefined;
 } | {
     tfo: boolean | undefined;
     name: string;
@@ -253,21 +280,28 @@ declare function encode(config: SupportedConfig): {
     network?: undefined;
 };
 
-declare const index$1_decode: typeof decode;
-declare const index$1_encode: typeof encode;
-declare namespace index$1 {
-  export { index$1_decode as decode, index$1_encode as encode };
+declare const index$2_decode: typeof decode;
+declare const index$2_encode: typeof encode;
+declare namespace index$2 {
+  export { index$2_decode as decode, index$2_encode as encode };
 }
 
 declare function decodeOne(sip002: string): ShadowSocksConfig;
 declare function decodeBase64Multiline(text: string): string[];
 declare function decodeMultiline(text: string): ShadowSocksConfig[];
 
-declare const index_decodeBase64Multiline: typeof decodeBase64Multiline;
-declare const index_decodeMultiline: typeof decodeMultiline;
-declare const index_decodeOne: typeof decodeOne;
+declare const index$1_decodeBase64Multiline: typeof decodeBase64Multiline;
+declare const index$1_decodeMultiline: typeof decodeMultiline;
+declare const index$1_decodeOne: typeof decodeOne;
+declare namespace index$1 {
+  export { index$1_decodeBase64Multiline as decodeBase64Multiline, index$1_decodeMultiline as decodeMultiline, index$1_decodeOne as decodeOne };
+}
+
+declare function parse(line: string): TrojanConfig;
+
+declare const index_parse: typeof parse;
 declare namespace index {
-  export { index_decodeBase64Multiline as decodeBase64Multiline, index_decodeMultiline as decodeMultiline, index_decodeOne as decodeOne };
+  export { index_parse as parse };
 }
 
-export { type HttpProxyConfig, type Hysteria2Config, type ShadowSocksConfig, type SharedConfigBase, type SnellConfig, type Socks5Config, type SupportedConfig, type TrojanBasicConfig, type TrojanConfig, type TuicConfig, type VmessConfig, index$1 as clash, index as ss, index$2 as surge };
+export { type HttpProxyConfig, type Hysteria2Config, type ShadowSocksConfig, type SharedConfigBase, type SnellConfig, type Socks5Config, type SupportedConfig, type TrojanBasicConfig, type TrojanConfig, type TuicConfig, type TuicV5Config, type VmessConfig, index$2 as clash, index$1 as ss, index$3 as surge, index as trojan };

package/dist/es/index.mjs

@@ -46,7 +46,8 @@ const strKeys = new Set([
     'block-quic',
     'ws-path',
     'ws-headers',
-    'port-hopping'
+    'port-hopping',
+    'token'
 ]);
 const isProxyStrKey = (key)=>strKeys.has(key);
 const UNSUPPORTED_VALUE = Symbol('unsupported');
@@ -143,8 +144,19 @@ function decode$1(raw) {
                     sni: restDetails.sni,
                     uuid: restDetails.uuid,
                     alpn: restDetails.alpn,
+                    token: restDetails.token,
+                    ...shared
+                };
+            }
+        case 'tuic-v5':
+            {
+                return {
+                    type: 'tuic-v5',
+                    uuid: restDetails.uuid,
+                    alpn: restDetails.alpn,
                     password: restDetails.password,
-                    version: restDetails.version,
+                    sni: restDetails.sni,
+                    skipCertVerify: restDetails['skip-cert-verify'],
                     ...shared
                 };
             }
@@ -232,7 +244,7 @@ function encode$1(config) {
             ]);
         case 'tuic':
             return joinString([
-                `${config.name} = tuic, ${config.server}, ${config.port}, sni=${config.sni}, uuid=${config.uuid}, alpn=${config.alpn}, password=${config.password}, version=${config.version}`,
+                `${config.name} = tuic, ${config.server}, ${config.port}, sni=${config.sni}, uuid=${config.uuid}, alpn=${config.alpn}, token=${config.token}`,
                 ...shared
             ]);
         case 'socks5':
@@ -270,12 +282,22 @@ function encode$1(config) {
                 `skip-cert-verify=${config.skipCertVerify}`,
                 ...shared
             ]);
+        case 'tuic-v5':
+            return joinString([
+                `${config.name} = tuic-v5, ${config.server}, ${config.port}`,
+                `password=${config.password}`,
+                `uuid=${config.uuid}`,
+                `alpn=${config.alpn}`,
+                `skip-cert-verify=${config.skipCertVerify}`,
+                `sni=${config.sni}`,
+                ...shared
+            ]);
         default:
             never(config, 'type (clash encode)');
     }
 }
 
-var index$2 = {
+var index$3 = {
   __proto__: null,
   decode: decode$1,
   encode: encode$1
@@ -390,6 +412,7 @@ function encode(config) {
                 ...shared
             };
         case 'tuic':
+        case 'tuic-v5':
             return {
                 name: config.name,
                 type: 'tuic',
@@ -398,8 +421,11 @@ function encode(config) {
                 sni: config.sni,
                 uuid: config.uuid,
                 alpn: config.alpn.split(',').map((x)=>x.trim()),
-                token: config.password,
-                version: config.version,
+                ...config.type === 'tuic' ? {
+                    token: config.token
+                } : {
+                    password: config.password
+                },
                 udp: true,
                 ...shared
             };
@@ -467,7 +493,7 @@ function parseStringToObject(input) {
     }, {});
 }
 
-var index$1 = {
+var index$2 = {
   __proto__: null,
   decode: decode,
   encode: encode
@@ -488,8 +514,22 @@ function decodeOne(sip002) {
     }
     const [serverName, _1] = server.split(':');
     const [_2, encodedName] = _1.split('#');
-    const [port, _plugins] = _2.split('/');
-    // TODO: implement plugin parsing
+    const [port, pluginsStr] = _2.split('/');
+    let plugin = null;
+    if (pluginsStr) {
+        try {
+            plugin = new URLSearchParams(pluginsStr).get('plugin');
+        } catch (e) {
+            const err = new Error(`[ss.decodeOne] Invalid plugins: ${pluginsStr}`);
+            err.cause = e;
+            throw err;
+        }
+    }
+    const pluginArgs = (plugin?.split(';') ?? []).reduce((acc, cur)=>{
+        const [key, value] = cur.split('=');
+        acc[key] = value;
+        return acc;
+    }, {});
     return {
         raw: sip002,
         type: 'ss',
@@ -498,7 +538,9 @@ function decodeOne(sip002) {
         port: number(port),
         cipher,
         password,
-        udp: true
+        udp: true,
+        obfs: 'obfs-local' in pluginArgs && 'obfs' in pluginArgs && (pluginArgs.obfs === 'http' || pluginArgs.obfs === 'tls') ? pluginArgs.obfs : undefined,
+        obfsHost: 'obfs-host' in pluginArgs ? pluginArgs['obfs-host'] : undefined
     };
 }
 function decodeBase64Multiline(text) {
@@ -508,11 +550,39 @@ function decodeMultiline(text) {
     return decodeBase64Multiline(text).map((line)=>decodeOne(line));
 }
 
-var index = {
+var index$1 = {
   __proto__: null,
   decodeBase64Multiline: decodeBase64Multiline,
   decodeMultiline: decodeMultiline,
   decodeOne: decodeOne
 };
 
-export { index$1 as clash, index as ss, index$2 as surge };
+function parse(line) {
+    const url = new URL(line);
+    // trojan://password@remote_host:remote_port
+    const password = url.username;
+    const server = url.hostname;
+    const port = Number.parseInt(url.port, 10);
+    if (Number.isNaN(port)) {
+        throw new TypeError('invalid port: ' + url.port);
+    }
+    const name = decodeURIComponent(url.hash.slice(1));
+    return {
+        raw: line,
+        name,
+        type: 'trojan',
+        server,
+        port,
+        password,
+        udp: true,
+        sni: url.searchParams.get('sni') ?? server,
+        skipCertVerify: true
+    };
+}
+
+var index = {
+  __proto__: null,
+  parse: parse
+};
+
+export { index$2 as clash, index$1 as ss, index$3 as surge, index as trojan };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodelistparser",
-  "version": "0.1.4",
+  "version": "0.3.0",
   "description": "Surge / Mihomo (Clash.Meta) nodelist / proxy provider parser and generator.",
   "repository": {
     "type": "git",
@@ -37,19 +37,19 @@
     "foxts": "^1.5.1"
   },
   "devDependencies": {
-    "@eslint-sukka/node": "^6.14.0",
+    "@eslint-sukka/node": "^6.16.1",
     "@swc-node/register": "^1.10.9",
-    "@swc/core": "^1.10.16",
+    "@swc/core": "^1.11.8",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^22.13.4",
+    "@types/node": "^22.13.10",
     "bumpp": "^10.0.3",
-    "bunchee": "^6.3.4",
-    "eslint": "^9.20.1",
-    "eslint-config-sukka": "^6.14.0",
-    "eslint-formatter-sukka": "^6.14.0",
+    "bunchee": "^6.4.0",
+    "eslint": "^9.22.0",
+    "eslint-config-sukka": "^6.16.1",
+    "eslint-formatter-sukka": "^6.16.1",
     "expect": "^29.7.0",
     "mocha": "^11.1.0",
-    "typescript": "^5.7.3"
+    "typescript": "^5.8.2"
   },
   "scripts": {
     "lint": "eslint --format=sukka .",