@ctrl/magnet-link 2.0.4 → 3.1.1

package/dist/src/bep53.d.ts

@@ -0,0 +1,2 @@
+export declare function composeRange(range: number[]): string[];
+export declare function parseRange(range: string[]): number[];

package/dist/src/bep53.js

@@ -0,0 +1,20 @@
+export function composeRange(range) {
+    return range
+        .reduce((acc, cur, idx, arr) => {
+        if (idx === 0 || cur !== arr[idx - 1] + 1) {
+            acc.push([]);
+        }
+        acc[acc.length - 1].push(`${cur}`);
+        return acc;
+    }, [])
+        .map(cur => {
+        return cur.length > 1 ? `${cur[0]}-${cur[cur.length - 1]}` : `${cur[0]}`;
+    });
+}
+export function parseRange(range) {
+    const generateRange = (start, end = start) => Array.from({ length: end - start + 1 }, (_, idx) => idx + start);
+    return range.reduce((acc, cur) => {
+        const r = cur.split('-').map(cur => parseInt(cur, 10));
+        return acc.concat(generateRange(r[0], r[1]));
+    }, []);
+}

package/dist/{index.d.ts → src/index.d.ts}

@@ -1,3 +1,4 @@
+/// <reference types="node" resolution-mode="require"/>
 export interface MagnetData {
     /**
      * Is the info-hash hex encoded, for a total of 40 characters. For compatability with existing links in the wild, clients should also support the 32 character base32 encoded info-hash.
@@ -7,11 +8,14 @@ export interface MagnetData {
      * Is the multihash formatted, hex encoded full infohash for torrents in the new metadata format. 'btmh' and 'btih' exact topics may exist in the same magnet if they describe the same hybrid torrent.
      * @link http://www.bittorrent.org/beps/bep_0009.html
      */
-    xt: string | string[];
+    xt?: string | string[];
     /**
      * Parsed xt= parameter see xt
      */
     infoHash?: string;
+    infoHashBuffer?: Buffer;
+    infoHashV2?: string;
+    infoHashV2Buffer?: Buffer;
     /**
      * The display name that may be used by the client to display while waiting for metadata
      */
@@ -44,6 +48,8 @@ export interface MagnetData {
      * "keyword topic": a more general search, specifying search terms rather than a particular file
      */
     kt?: string[];
+    so?: string[] | number[];
+    'x.pe'?: string | string[];
     /**
      * "keyword topic": a more general search, specifying search terms rather than a particular file
      */
@@ -60,6 +66,9 @@ export interface MagnetData {
      * Combined as= and ws= parameters if they exist
      */
     urlList?: string[];
+    peerAddresses?: string[];
+    publicKey?: string;
+    publicKeyBuffer?: Buffer;
 }
 export declare function magnetDecode(uri: string): MagnetData;
 export declare function magnetEncode(data: MagnetData): string;

package/dist/{module → src}/index.js

@@ -1,4 +1,5 @@
 import { base32Decode } from '@ctrl/ts-base32';
+import * as bep53Range from './bep53.js';
 const start = 'magnet:?';
 export function magnetDecode(uri) {
     // Support 'stream-magnet:' as well
@@ -23,9 +24,12 @@ export function magnetDecode(uri) {
         }
         // If there are repeated parameters, return an array of values
         if (r && Array.isArray(r)) {
-            return r.push(val);
+            r.push(val);
+            return;
         }
         result[key] = [r, val];
+        // eslint-disable-next-line no-useless-return
+        return;
     });
     if (result.xt) {
         let m;
@@ -38,8 +42,29 @@ export function magnetDecode(uri) {
                 const decodedStr = base32Decode(m[1]);
                 result.infoHash = Buffer.from(decodedStr).toString('hex');
             }
+            else if ((m = xt.match(/^urn:btmh:1220(.{64})/))) {
+                result.infoHashV2 = m[1].toLowerCase();
+            }
         });
     }
+    if (result.xs) {
+        let m;
+        const xss = Array.isArray(result.xs) ? result.xs : [result.xs];
+        xss.forEach(xs => {
+            if ((m = /^urn:btpk:(.{64})/.exec(xs))) {
+                result.publicKey = m[1]?.toLowerCase();
+            }
+        });
+    }
+    if (result.infoHash) {
+        result.infoHashBuffer = Buffer.from(result.infoHash, 'hex');
+    }
+    if (result.infoHashV2) {
+        result.infoHashV2Buffer = Buffer.from(result.infoHashV2, 'hex');
+    }
+    if (result.publicKey) {
+        result.publicKeyBuffer = Buffer.from(result.publicKey, 'hex');
+    }
     if (result.dn) {
         result.name = result.dn;
     }
@@ -62,8 +87,13 @@ export function magnetDecode(uri) {
     if (typeof result.ws === 'string' || Array.isArray(result.ws)) {
         result.urlList = result.urlList.concat(result.ws);
     }
+    result.peerAddresses = [];
+    if (typeof result['x.pe'] === 'string' || Array.isArray(result['x.pe'])) {
+        result.peerAddresses = result.peerAddresses.concat(result['x.pe']);
+    }
     result.announce = [...new Set(result.announce)].sort((a, b) => a.localeCompare(b));
     result.urlList = [...new Set(result.urlList)].sort((a, b) => a.localeCompare(b));
+    result.peerAddresses = [...new Set(result.peerAddresses)];
     return result;
 }
 /**
@@ -83,6 +113,10 @@ function parseQueryParamValue(key, val) {
     if (key === 'kt') {
         return decodeURIComponent(val).split('+');
     }
+    // bep53
+    if (key === 'so') {
+        return bep53Range.parseRange(decodeURIComponent(val).split(','));
+    }
     // Cast file index (ix) to a number
     if (key === 'ix') {
         return Number(val);
@@ -91,11 +125,44 @@ function parseQueryParamValue(key, val) {
 }
 export function magnetEncode(data) {
     const obj = { ...data }; // Shallow clone object
+    // Deduplicate xt by using a set
+    let xts = new Set();
+    if (obj.xt && typeof obj.xt === 'string') {
+        xts.add(obj.xt);
+    }
+    if (obj.xt && Array.isArray(obj.xt)) {
+        xts = new Set(obj.xt);
+    }
+    if (obj.infoHashBuffer) {
+        xts.add(`urn:btih:${obj.infoHashBuffer.toString('hex')}`);
+    }
+    if (obj.infoHash) {
+        xts.add(`urn:btih:${obj.infoHash}`);
+    }
+    if (obj.infoHashV2Buffer) {
+        xts.add((obj.xt = `urn:btmh:1220${obj.infoHashV2Buffer.toString('hex')}`));
+    }
+    if (obj.infoHashV2) {
+        xts.add(`urn:btmh:1220${obj.infoHashV2}`);
+    }
+    const xtsDeduped = Array.from(xts);
+    if (xtsDeduped.length === 1) {
+        obj.xt = xtsDeduped[0];
+    }
+    if (xtsDeduped.length > 1) {
+        obj.xt = xtsDeduped;
+    }
     // Support using convenience names, in addition to spec names
     // (example: `infoHash` for `xt`, `name` for `dn`)
     if (obj.infoHash) {
         obj.xt = `urn:btih:${obj.infoHash}`;
     }
+    if (obj.publicKeyBuffer) {
+        obj.xs = `urn:btpk:${obj.publicKeyBuffer.toString('hex')}`;
+    }
+    if (obj.publicKey) {
+        obj.xs = `urn:btpk:${obj.publicKey}`;
+    }
     if (obj.name) {
         obj.dn = obj.name;
     }
@@ -109,32 +176,44 @@ export function magnetEncode(data) {
         obj.ws = obj.urlList;
         delete obj.as;
     }
+    if (obj.peerAddresses) {
+        obj['x.pe'] = obj.peerAddresses;
+    }
     return Object.keys(obj)
-        .filter(key => key.length === 2)
+        .filter(key => key.length === 2 || key === 'x.pe')
         .reduce((prev, key, i) => {
         let acc = prev;
         const values = Array.isArray(obj[key]) ? obj[key] : [obj[key]];
         values.forEach((val, j) => {
-            if ((i > 0 || j > 0) && (key !== 'kt' || j === 0)) {
-                acc = `${acc}&`;
+            if ((i > 0 || j > 0) && ((key !== 'kt' && key !== 'so') || j === 0)) {
+                acc += '&';
             }
-            let res = val;
             if (key === 'dn') {
-                res = encodeURIComponent(val).replace(/%20/g, '+');
+                val = encodeURIComponent(val).replace(/%20/g, '+');
             }
-            if (key === 'tr' || key === 'xs' || key === 'as' || key === 'ws') {
-                res = encodeURIComponent(val);
+            if (key === 'tr' || key === 'as' || key === 'ws') {
+                val = encodeURIComponent(val);
+            }
+            // Don't URI encode BEP46 keys
+            if (key === 'xs' && !val.startsWith('urn:btpk:')) {
+                val = encodeURIComponent(val);
             }
             if (key === 'kt') {
-                res = encodeURIComponent(val);
+                val = encodeURIComponent(val);
+            }
+            if (key === 'so') {
+                return;
             }
             if (key === 'kt' && j > 0) {
-                acc = `${acc}+${res}`;
+                acc += `+${val}`;
             }
             else {
-                acc = `${acc}${key}=${res}`;
+                acc += `${key}=${val}`;
             }
         });
+        if (key === 'so') {
+            acc += `${key}=${bep53Range.composeRange(values)}`;
+        }
         return acc;
     }, `${start}`);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/magnet-link",
-  "version": "2.0.4",
+  "version": "3.1.1",
   "description": "Parse a magnet URI into an object",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "homepage": "https://magnet-link.vercel.app",
@@ -12,63 +12,48 @@
     "link",
     "magnet-uri"
   ],
-  "main": "dist/index.js",
-  "module": "dist/module/index.js",
-  "typings": "dist/index.d.ts",
+  "type": "module",
+  "exports": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
   "files": [
-    "dist"
+    "dist/src"
   ],
   "sideEffects": false,
-  "publishConfig": {
-    "access": "public"
-  },
   "scripts": {
-    "build:demo": "rollup -c rollup.demo.js",
-    "watch:demo": "rollup -c rollup.demo.js -w",
-    "lint": "eslint --ext .js,.ts, .",
-    "lint:fix": "eslint --fix --ext .js,.ts, .",
+    "demo:build": "npm run build --workspace=demo",
+    "demo:watch": "npm run dev --workspace=demo",
+    "lint": "eslint --ext .ts .",
+    "lint:fix": "eslint --fix --ext .ts .",
     "prepare": "npm run build",
-    "build": "tsc -p tsconfig.build.json && tsc -p tsconfig.module.json",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:ci": "jest --coverage --no-cache"
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:ci": "vitest run --coverage --reporter=junit --outputFile=./junit.xml"
   },
   "dependencies": {
-    "@ctrl/ts-base32": "^1.2.4"
+    "@ctrl/ts-base32": "^2.1.1"
   },
   "devDependencies": {
-    "@babel/plugin-transform-modules-commonjs": "7.12.1",
-    "@babel/preset-typescript": "7.12.7",
-    "@ctrl/eslint-config": "1.2.8",
-    "@jest/globals": "26.6.2",
-    "@rollup/plugin-node-resolve": "11.0.0",
-    "@types/node": "14.14.13",
+    "@ctrl/eslint-config": "3.4.4",
+    "@sindresorhus/tsconfig": "3.0.1",
+    "@types/node": "17.0.39",
     "buffer": "6.0.3",
-    "jest": "26.6.3",
-    "rollup": "2.34.2",
-    "rollup-plugin-livereload": "2.0.0",
-    "rollup-plugin-node-builtins": "2.1.2",
-    "rollup-plugin-node-globals": "1.4.0",
-    "rollup-plugin-serve": "1.1.0",
-    "rollup-plugin-terser": "7.0.2",
-    "rollup-plugin-typescript2": "0.29.0",
-    "typescript": "4.1.3"
-  },
-  "release": {
-    "branch": "master"
+    "c8": "7.11.3",
+    "typescript": "4.7.3",
+    "vitest": "0.13.1"
   },
-  "jest": {
-    "testEnvironment": "node"
+  "workspaces": [
+    "demo"
+  ],
+  "publishConfig": {
+    "access": "public"
   },
-  "babel": {
-    "presets": [
-      "@babel/preset-typescript"
-    ],
-    "plugins": [
-      "@babel/plugin-transform-modules-commonjs"
+  "release": {
+    "branches": [
+      "master"
     ]
   },
   "engines": {
-    "node": ">=10.19.0"
+    "node": ">=14.16"
   }
 }

package/dist/index.js

@@ -1,145 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.magnetEncode = exports.magnetDecode = void 0;
-const ts_base32_1 = require("@ctrl/ts-base32");
-const start = 'magnet:?';
-function magnetDecode(uri) {
-    // Support 'stream-magnet:' as well
-    const data = uri.substr(uri.indexOf(start) + start.length);
-    const params = data && data.length >= 0 ? data.split('&') : [];
-    const result = {};
-    params.forEach(param => {
-        const keyval = param.split('=');
-        // This keyval is invalid, skip it
-        if (keyval.length !== 2) {
-            return;
-        }
-        const key = keyval[0];
-        const val = parseQueryParamValue(key, keyval[1]);
-        if (val === undefined) {
-            return;
-        }
-        const r = result[key];
-        if (!r) {
-            result[key] = val;
-            return result;
-        }
-        // If there are repeated parameters, return an array of values
-        if (r && Array.isArray(r)) {
-            return r.push(val);
-        }
-        result[key] = [r, val];
-    });
-    if (result.xt) {
-        let m;
-        const xts = Array.isArray(result.xt) ? result.xt : [result.xt];
-        xts.forEach((xt) => {
-            if ((m = xt.match(/^urn:btih:(.{40})/))) {
-                result.infoHash = m[1].toLowerCase();
-            }
-            else if ((m = xt.match(/^urn:btih:(.{32})/))) {
-                const decodedStr = ts_base32_1.base32Decode(m[1]);
-                result.infoHash = Buffer.from(decodedStr).toString('hex');
-            }
-        });
-    }
-    if (result.dn) {
-        result.name = result.dn;
-    }
-    if (result.kt) {
-        result.keywords = result.kt;
-    }
-    if (typeof result.tr === 'string') {
-        result.announce = [result.tr];
-    }
-    else if (Array.isArray(result.tr)) {
-        result.announce = result.tr;
-    }
-    else {
-        result.announce = [];
-    }
-    result.urlList = [];
-    if (typeof result.as === 'string' || Array.isArray(result.as)) {
-        result.urlList = result.urlList.concat(result.as);
-    }
-    if (typeof result.ws === 'string' || Array.isArray(result.ws)) {
-        result.urlList = result.urlList.concat(result.ws);
-    }
-    result.announce = [...new Set(result.announce)].sort((a, b) => a.localeCompare(b));
-    result.urlList = [...new Set(result.urlList)].sort((a, b) => a.localeCompare(b));
-    return result;
-}
-exports.magnetDecode = magnetDecode;
-/**
- * Specific query parameters have expected formats, this attempts to parse them in the correct way
- */
-function parseQueryParamValue(key, val) {
-    // Clean up torrent name
-    if (key === 'dn') {
-        return decodeURIComponent(val).replace(/\+/g, ' ');
-    }
-    // Address tracker (tr), exact source (xs), and acceptable source (as) are encoded
-    // URIs, so decode them
-    if (key === 'tr' || key === 'xs' || key === 'as' || key === 'ws') {
-        return decodeURIComponent(val);
-    }
-    // Return keywords as an array
-    if (key === 'kt') {
-        return decodeURIComponent(val).split('+');
-    }
-    // Cast file index (ix) to a number
-    if (key === 'ix') {
-        return Number(val);
-    }
-    return val;
-}
-function magnetEncode(data) {
-    const obj = { ...data }; // Shallow clone object
-    // Support using convenience names, in addition to spec names
-    // (example: `infoHash` for `xt`, `name` for `dn`)
-    if (obj.infoHash) {
-        obj.xt = `urn:btih:${obj.infoHash}`;
-    }
-    if (obj.name) {
-        obj.dn = obj.name;
-    }
-    if (obj.keywords) {
-        obj.kt = obj.keywords;
-    }
-    if (obj.announce) {
-        obj.tr = obj.announce;
-    }
-    if (obj.urlList) {
-        obj.ws = obj.urlList;
-        delete obj.as;
-    }
-    return Object.keys(obj)
-        .filter(key => key.length === 2)
-        .reduce((prev, key, i) => {
-        let acc = prev;
-        const values = Array.isArray(obj[key]) ? obj[key] : [obj[key]];
-        values.forEach((val, j) => {
-            if ((i > 0 || j > 0) && (key !== 'kt' || j === 0)) {
-                acc = `${acc}&`;
-            }
-            let res = val;
-            if (key === 'dn') {
-                res = encodeURIComponent(val).replace(/%20/g, '+');
-            }
-            if (key === 'tr' || key === 'xs' || key === 'as' || key === 'ws') {
-                res = encodeURIComponent(val);
-            }
-            if (key === 'kt') {
-                res = encodeURIComponent(val);
-            }
-            if (key === 'kt' && j > 0) {
-                acc = `${acc}+${res}`;
-            }
-            else {
-                acc = `${acc}${key}=${res}`;
-            }
-        });
-        return acc;
-    }, `${start}`);
-}
-exports.magnetEncode = magnetEncode;