@ctrl/torrent-file 4.2.0 → 4.4.0

package/README.md

@@ -1,10 +1,11 @@
 # torrent-file [![npm](https://badgen.net/npm/v/@ctrl/torrent-file)](https://www.npmjs.com/package/@ctrl/torrent-file) [![coverage](https://badgen.net/codecov/c/github/scttcper/torrent-file)](https://codecov.io/gh/scttcper/torrent-file) [![bundlesize](https://badgen.net/bundlephobia/min/@ctrl/torrent-file)](https://bundlephobia.com/result?p=@ctrl/torrent-file)
 
-> Parse a torrent file and read encoded data. 
+> Parse a torrent file and read encoded data.
 
 This project is based on [parse-torrent](https://www.npmjs.com/package/parse-torrent) and [node-bencode](https://github.com/themasch/node-bencode) to parse the data of a torrent file. This library implements its own [bencode](http://www.bittorrent.org/beps/bep_0003.html) encoder and decoder that does not use `Buffer`.
 
 ### Install
+
 ```console
 npm install @ctrl/torrent-file
 ```
@@ -12,9 +13,12 @@ npm install @ctrl/torrent-file
 ### API
 
 ##### info
+
 The content of the metainfo file.
+
 ```ts
 import fs from 'fs';
+
 import { info } from '@ctrl/torrent-file';
 
 const torrentInfo = info(fs.readFileSync('myfile'));
@@ -22,9 +26,12 @@ console.log({ torrentInfo });
 ```
 
 ##### files
+
 data about the files described in the torrent file, includes hashes of the pieces
+
 ```ts
 import fs from 'fs';
+
 import { files } from '@ctrl/torrent-file';
 
 const torrentFiles = files(fs.readFileSync('myfile'));
@@ -32,18 +39,21 @@ console.log({ torrentFiles });
 ```
 
 ##### hash
+
 sha1 of torrent file info. This hash is commenly used by torrent clients as the ID of the torrent. It is async and sha1 encoding is handled by [crypto-hash](https://github.com/sindresorhus/crypto-hash)
+
 ```ts
 import fs from 'fs';
+
 import { hash } from '@ctrl/torrent-file';
 
 (async () => {
   const torrentHash = await hash(fs.readFileSync('myfile'));
   console.log({ torrentHash });
-})()
+})();
 ```
 
-
 ### See Also
+
 [parse-torrent](https://www.npmjs.com/package/parse-torrent) - "@ctrl/torrent-file" torrent parsing based very heavily off this project  
-[node-bencode](https://github.com/themasch/node-bencode) - bencoder built into this project heavily based off this project   
+[node-bencode](https://github.com/themasch/node-bencode) - bencoder built into this project heavily based off this project

package/dist/src/bencode/decode.js

@@ -1,9 +1,8 @@
 import { stringToUint8Array, uint8ArrayToString } from 'uint8array-extras';
-import { isValidUTF8 } from './utils.js';
 const td = new TextDecoder();
 class Decoder {
-    buf;
     idx = 0;
+    buf;
     constructor(buf) {
         this.buf = buf;
     }
@@ -70,8 +69,7 @@ class Decoder {
     nextBufOrString() {
         const length = this.readNumber();
         this.assertByte(':');
-        const buf = this.readBytes(length);
-        return isValidUTF8(buf) ? td.decode(buf) : buf;
+        return this.readBytes(length);
     }
     nextString() {
         const length = this.readNumber();

package/dist/src/bencode/encode.js

@@ -1,5 +1,4 @@
 import { concatUint8Arrays, stringToUint8Array } from 'uint8array-extras';
-import { cmpRawString } from './utils.js';
 const te = new TextEncoder();
 const encodeString = (str) => {
     const lengthBytes = new TextEncoder().encode(str.length.toString());
@@ -33,7 +32,7 @@ const encodeNumber = (num) => {
 const encodeDictionary = (obj) => {
     const results = [];
     Object.keys(obj)
-        .sort(cmpRawString)
+        .sort()
         .forEach(key => {
         results.push(encodeString(key));
         results.push(new Uint8Array(encode(obj[key])));
@@ -53,7 +52,6 @@ export const encode = (data) => {
     if (Array.isArray(data)) {
         return encodeArray(data);
     }
-    // eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check
     switch (typeof data) {
         case 'string': {
             return encodeString(data);

package/dist/src/bencode/utils.d.ts

@@ -1,3 +1 @@
 export declare const cmpRawString: (str1: string, str2: string) => number;
-export declare const typedArraysAreEqual: <T extends Uint8Array>(a: T, b: T) => boolean;
-export declare const isValidUTF8: (buf: Uint8Array) => boolean;

package/dist/src/bencode/utils.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-bitwise */
 // str1 > str2: 1
 // str1 === str2: 0
 // str1 < str2: -1
@@ -19,76 +18,3 @@ export const cmpRawString = (str1, str2) => {
     }
     return v1.length < v2.length ? -1 : 1;
 };
-export const typedArraysAreEqual = (a, b) => {
-    if (a.byteLength !== b.byteLength) {
-        return false;
-    }
-    return a.every((val, i) => val === b[i]);
-};
-// Copied from https://github.com/hcodes/isutf8/blob/master/src/index.ts
-/*
-    https://tools.ietf.org/html/rfc3629
-    UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4
-    UTF8-1    = %x00-7F
-    UTF8-2    = %xC2-DF UTF8-tail
-    UTF8-3    = %xE0 %xA0-BF UTF8-tail
-                %xE1-EC 2( UTF8-tail )
-                %xED %x80-9F UTF8-tail
-                %xEE-EF 2( UTF8-tail )
-    UTF8-4    = %xF0 %x90-BF 2( UTF8-tail )
-                %xF1-F3 3( UTF8-tail )
-                %xF4 %x80-8F 2( UTF8-tail )
-    UTF8-tail = %x80-BF
-*/
-export const isValidUTF8 = (buf) => {
-    let i = 0;
-    const len = buf.length;
-    while (i < len) {
-        // UTF8-1 = %x00-7F
-        if (buf[i] <= 0x7f) {
-            i++;
-            continue;
-        }
-        // UTF8-2 = %xC2-DF UTF8-tail
-        if (buf[i] >= 0xc2 && buf[i] <= 0xdf) {
-            // if(buf[i + 1] >= 0x80 && buf[i + 1] <= 0xBF) {
-            if (buf[i + 1] >> 6 === 2) {
-                i += 2;
-                continue;
-                // biome-ignore lint/style/noUselessElse: false positive
-            }
-            else {
-                return false;
-            }
-        }
-        // UTF8-3 = %xE0 %xA0-BF UTF8-tail
-        // UTF8-3 = %xED %x80-9F UTF8-tail
-        if (((buf[i] === 0xe0 && buf[i + 1] >= 0xa0 && buf[i + 1] <= 0xbf) ||
-            (buf[i] === 0xed && buf[i + 1] >= 0x80 && buf[i + 1] <= 0x9f)) &&
-            buf[i + 2] >> 6 === 2) {
-            i += 3;
-            continue;
-        }
-        // UTF8-3 = %xE1-EC 2( UTF8-tail )
-        // UTF8-3 = %xEE-EF 2( UTF8-tail )
-        if (((buf[i] >= 0xe1 && buf[i] <= 0xec) || (buf[i] >= 0xee && buf[i] <= 0xef)) &&
-            buf[i + 1] >> 6 === 2 &&
-            buf[i + 2] >> 6 === 2) {
-            i += 3;
-            continue;
-        }
-        // UTF8-4 = %xF0 %x90-BF 2( UTF8-tail )
-        //          %xF1-F3 3( UTF8-tail )
-        //          %xF4 %x80-8F 2( UTF8-tail )
-        if (((buf[i] === 0xf0 && buf[i + 1] >= 0x90 && buf[i + 1] <= 0xbf) ||
-            (buf[i] >= 0xf1 && buf[i] <= 0xf3 && buf[i + 1] >> 6 === 2) ||
-            (buf[i] === 0xf4 && buf[i + 1] >= 0x80 && buf[i + 1] <= 0x8f)) &&
-            buf[i + 2] >> 6 === 2 &&
-            buf[i + 3] >> 6 === 2) {
-            i += 4;
-            continue;
-        }
-        return false;
-    }
-    return true;
-};

package/dist/src/torrentFile.d.ts

@@ -1,6 +1,6 @@
 export declare const sha1: (input: Uint8Array) => string;
 /**
- * sha1 of torrent file info. This hash is commenly used by torrent clients as the ID of the torrent.
+ * sha1 of torrent file info. This hash is commonly used by torrent clients as the ID of the torrent.
  */
 export declare function hash(file: Uint8Array): string;
 export interface TorrentFileData {

package/dist/src/torrentFile.js

@@ -2,6 +2,13 @@ import { createHash } from 'node:crypto';
 import { join, sep } from 'node:path';
 import { isUint8Array, uint8ArrayToHex, uint8ArrayToString } from 'uint8array-extras';
 import { decode, encode } from './bencode/index.js';
+// Helper function to convert Uint8Array to string for display
+const toString = (value) => {
+    if (value instanceof Uint8Array) {
+        return uint8ArrayToString(value);
+    }
+    return value.toString();
+};
 export const sha1 = (input) => {
     const hash = createHash('sha1');
     // Update the hash object with the data
@@ -9,7 +16,7 @@ export const sha1 = (input) => {
     return hash.digest('hex');
 };
 /**
- * sha1 of torrent file info. This hash is commenly used by torrent clients as the ID of the torrent.
+ * sha1 of torrent file info. This hash is commonly used by torrent clients as the ID of the torrent.
  */
 export function hash(file) {
     const torrent = decode(file);
@@ -28,9 +35,9 @@ export function files(file) {
         pieces: [],
     };
     const files = torrent.info.files || [torrent.info];
-    const name = (torrent.info['name.utf-8'] || torrent.info.name).toString();
+    const name = toString(torrent.info['name.utf-8'] || torrent.info.name);
     result.files = files.map((file, i) => {
-        const parts = [name, ...(file['path.utf-8'] || file.path || [])].map(p => p.toString());
+        const parts = [name, ...(file['path.utf-8'] || file.path || [])].map(p => toString(p));
         return {
             path: join(sep, ...parts).slice(1),
             name: parts[parts.length - 1],
@@ -61,7 +68,7 @@ function splitPieces(buf) {
 export function info(file) {
     const torrent = decode(file);
     const result = {
-        name: (torrent.info['name.utf-8'] || torrent.info.name).toString(),
+        name: toString(torrent.info['name.utf-8'] || torrent.info.name),
         announce: [],
         urlList: [],
     };
@@ -72,10 +79,10 @@ export function info(file) {
         result.created = new Date(torrent['creation date'] * 1000);
     }
     if (torrent['created by']) {
-        result.createdBy = torrent['created by'].toString();
+        result.createdBy = toString(torrent['created by']);
     }
-    if (isUint8Array(torrent.comment)) {
-        result.comment = uint8ArrayToString(torrent.comment);
+    if (torrent.comment) {
+        result.comment = toString(torrent.comment);
     }
     // announce and announce-list will be missing if metadata fetched via ut_metadata
     if (Array.isArray(torrent['announce-list']) &&
@@ -83,12 +90,12 @@ export function info(file) {
         torrent['announce-list'].length > 0) {
         torrent['announce-list'].forEach((urls) => {
             urls.forEach((url) => {
-                result.announce.push(url.toString());
+                result.announce.push(toString(url));
             });
         });
     }
     else if (torrent.announce) {
-        result.announce.push(torrent.announce.toString());
+        result.announce.push(toString(torrent.announce));
     }
     if (result.announce.length) {
         result.announce = Array.from(new Set(result.announce));
@@ -98,7 +105,7 @@ export function info(file) {
         // some clients set url-list to empty string
         torrent['url-list'] = torrent['url-list'].length > 0 ? [torrent['url-list']] : [];
     }
-    result.urlList = (torrent['url-list'] || []).map((url) => url.toString());
+    result.urlList = (torrent['url-list'] || []).map((url) => toString(url));
     if (result.urlList.length) {
         result.urlList = Array.from(new Set(result.urlList));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/torrent-file",
-  "version": "4.2.0",
+  "version": "4.4.0",
   "description": "Parse a torrent file (name, hash, files, pieces)",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -17,12 +17,8 @@
   "sideEffects": false,
   "keywords": [],
   "scripts": {
-    "lint": "pnpm run '/^(lint:biome|lint:eslint)$/'",
-    "lint:biome": "biome check .",
-    "lint:eslint": "eslint .",
-    "lint:fix": "pnpm run '/^(lint:biome|lint:eslint):fix$/'",
-    "lint:eslint:fix": "eslint . --fix",
-    "lint:biome:fix": "biome check . --apply",
+    "lint": "oxlint . && prettier --check . --experimental-cli",
+    "lint:fix": "oxlint . --fix && prettier --write . --log-level=error --experimental-cli",
     "prepare": "npm run build",
     "build": "tsc",
     "test": "vitest run",
@@ -30,18 +26,41 @@
     "test:ci": "vitest run --coverage --reporter=default --reporter=junit --outputFile=./junit.xml"
   },
   "dependencies": {
-    "uint8array-extras": "^1.4.0"
+    "uint8array-extras": "^1.5.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.9.4",
-    "@ctrl/eslint-config-biome": "4.3.1",
-    "@sindresorhus/tsconfig": "7.0.0",
-    "@types/node": "22.10.7",
-    "@vitest/coverage-v8": "3.0.2",
+    "@ctrl/oxlint-config": "1.2.7",
+    "@sindresorhus/tsconfig": "8.0.1",
+    "@trivago/prettier-plugin-sort-imports": "5.2.2",
+    "@types/node": "24.6.2",
+    "@vitest/coverage-v8": "3.2.4",
+    "oxlint": "1.19.0",
     "parse-torrent": "11.0.18",
-    "typescript": "5.7.3",
-    "vitest": "3.0.2"
+    "prettier": "3.6.2",
+    "typescript": "5.9.3",
+    "vitest": "3.2.4"
   },
+  "prettier": {
+    "singleQuote": true,
+    "trailingComma": "all",
+    "arrowParens": "avoid",
+    "semi": true,
+    "printWidth": 100,
+    "plugins": [
+      "@trivago/prettier-plugin-sort-imports"
+    ],
+    "importOrder": [
+      "^node:.*$",
+      "<THIRD_PARTY_MODULES>",
+      "^(@ctrl)(/.*|$)",
+      "^\\.\\./(?!.*\\.css$)",
+      "^\\./(?!.*\\.css$)(?=.*/)",
+      "^\\./(?!.*\\.css$)(?!.*/)"
+    ],
+    "importOrderSeparation": true,
+    "importOrderSortSpecifiers": false
+  },
+  "packageManager": "pnpm@10.18.0",
   "publishConfig": {
     "access": "public",
     "provenance": true