@ctrl/magnet-link 2.0.4 → 3.0.0

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

@@ -7,7 +7,7 @@ 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
      */

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

@@ -23,9 +23,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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/magnet-link",
-  "version": "2.0.4",
+  "version": "3.0.0",
   "description": "Parse a magnet URI into an object",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "homepage": "https://magnet-link.vercel.app",
@@ -12,63 +12,58 @@
     "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": "ava",
+    "test:watch": "ava --watch",
+    "test:ci": "c8 --reporter=text --reporter=lcov ava"
   },
   "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.2.0",
+    "@sindresorhus/tsconfig": "2.0.0",
+    "@types/node": "17.0.1",
+    "ava": "4.0.0-rc.1",
     "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"
-  },
-  "jest": {
-    "testEnvironment": "node"
+    "c8": "7.10.0",
+    "tsm": "2.2.1",
+    "typescript": "4.5.4"
   },
-  "babel": {
-    "presets": [
-      "@babel/preset-typescript"
+  "ava": {
+    "files": [
+      "test/**/*.spec.ts"
     ],
-    "plugins": [
-      "@babel/plugin-transform-modules-commonjs"
+    "extensions": {
+      "ts": "module"
+    },
+    "nodeArguments": [
+      "--loader=tsm"
     ]
   },
+  "workspaces": [
+    "demo"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "release": {
+    "branch": "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;