music-metadata 7.11.9 → 7.12.0

package/LICENSE.txt

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright © 2022 Borewit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -423,12 +423,12 @@ img.src = `data:${picture.format};base64,${picture.data.toString('base64')}`;
 
 ## Licence
 
-(The MIT License)
+The MIT License (MIT)
 
-Copyright (c) 2017 Borewit
+Copyright © 2022 Borewit
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/lib/common/RandomFileReader.d.ts

@@ -4,9 +4,10 @@ import { IRandomReader } from '../type';
  * Provides abstract file access via the IRandomRead interface
  */
 export declare class RandomFileReader implements IRandomReader {
+    private readonly fileHandle;
+    filePath: string;
     fileSize: number;
-    private readonly fd;
-    constructor(filePath: string, fileSize: number);
+    private constructor();
     /**
      * Read from a given position of an abstracted file or buffer.
      * @param buffer {Buffer} is the buffer that the data will be written to.
@@ -16,5 +17,6 @@ export declare class RandomFileReader implements IRandomReader {
      * @return {Promise<number>} bytes read
      */
     randomRead(buffer: Buffer, offset: number, length: number, position: number): Promise<number>;
-    close(): void;
+    close(): Promise<void>;
+    static init(filePath: string, fileSize: number): Promise<RandomFileReader>;
 }

package/lib/common/RandomFileReader.js

@@ -6,9 +6,10 @@ const fs = require("fs");
  * Provides abstract file access via the IRandomRead interface
  */
 class RandomFileReader {
-    constructor(filePath, fileSize) {
+    constructor(fileHandle, filePath, fileSize) {
+        this.fileHandle = fileHandle;
+        this.filePath = filePath;
         this.fileSize = fileSize;
-        this.fd = fs.openSync(filePath, 'r');
     }
     /**
      * Read from a given position of an abstracted file or buffer.
@@ -18,20 +19,16 @@ class RandomFileReader {
      * @param position {number} is an argument specifying where to begin reading from in the file.
      * @return {Promise<number>} bytes read
      */
-    randomRead(buffer, offset, length, position) {
-        return new Promise((resolve, reject) => {
-            fs.read(this.fd, buffer, offset, length, position, (err, bytesRead) => {
-                if (err) {
-                    reject(err);
-                }
-                else {
-                    resolve(bytesRead);
-                }
-            });
-        });
+    async randomRead(buffer, offset, length, position) {
+        const result = await this.fileHandle.read(buffer, offset, length, position);
+        return result.bytesRead;
     }
-    close() {
-        fs.closeSync(this.fd);
+    async close() {
+        return this.fileHandle.close();
+    }
+    static async init(filePath, fileSize) {
+        const fileHandle = await fs.promises.open(filePath, 'r');
+        return new RandomFileReader(fileHandle, filePath, fileSize);
     }
 }
 exports.RandomFileReader = RandomFileReader;

package/lib/common/Util.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { IRatio } from '../type';
 export declare type StringEncoding = 'ascii' | 'utf8' | 'utf16le' | 'ucs2' | 'base64url' | 'latin1' | 'hex';
 export interface ITextEncoding {
@@ -19,7 +18,7 @@ export declare function trimRightNull(x: string): string;
 /**
  * Decode string
  */
-export declare function decodeString(buffer: Buffer, encoding: StringEncoding): string;
+export declare function decodeString(uint8Array: Uint8Array, encoding: StringEncoding): string;
 export declare function stripNulls(str: string): string;
 /**
  * Read bit-aligned number start from buffer

package/lib/common/Util.js

@@ -52,19 +52,19 @@ function swapBytes(uint8Array) {
 /**
  * Decode string
  */
-function decodeString(buffer, encoding) {
+function decodeString(uint8Array, encoding) {
     // annoying workaround for a double BOM issue
     // https://github.com/leetreveil/musicmetadata/issues/84
-    if (buffer[0] === 0xFF && buffer[1] === 0xFE) { // little endian
-        return decodeString(buffer.subarray(2), encoding);
+    if (uint8Array[0] === 0xFF && uint8Array[1] === 0xFE) { // little endian
+        return decodeString(uint8Array.subarray(2), encoding);
     }
-    else if (encoding === 'utf16le' && buffer[0] === 0xFE && buffer[1] === 0xFF) {
+    else if (encoding === 'utf16le' && uint8Array[0] === 0xFE && uint8Array[1] === 0xFF) {
         // BOM, indicating big endian decoding
-        if ((buffer.length & 1) !== 0)
+        if ((uint8Array.length & 1) !== 0)
             throw new Error('Expected even number of octets for 16-bit unicode string');
-        return decodeString(swapBytes(buffer), encoding);
+        return decodeString(swapBytes(uint8Array), encoding);
     }
-    return buffer.toString(encoding);
+    return Buffer.from(uint8Array).toString(encoding);
 }
 exports.decodeString = decodeString;
 function stripNulls(str) {

package/lib/index.js

@@ -32,12 +32,12 @@ exports.parseStream = parseStream;
 async function parseFile(filePath, options = {}) {
     debug(`parseFile: ${filePath}`);
     const fileTokenizer = await strtok3.fromFile(filePath);
-    const fileReader = new RandomFileReader_1.RandomFileReader(filePath, fileTokenizer.fileInfo.size);
+    const fileReader = await RandomFileReader_1.RandomFileReader.init(filePath, fileTokenizer.fileInfo.size);
     try {
         await Core.scanAppendingHeaders(fileReader, options);
     }
     finally {
-        fileReader.close();
+        await fileReader.close();
     }
     try {
         const parserName = ParserFactory_1.ParserFactory.getParserIdForExtension(filePath);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "music-metadata",
   "description": "Music metadata parser for Node.js, supporting virtual any audio and tag format.",
-  "version": "7.11.9",
+  "version": "7.12.0",
   "author": {
     "name": "Borewit",
     "url": "https://github.com/Borewit"
@@ -90,28 +90,28 @@
     "file-type": "16.5.3",
     "media-typer": "^1.1.0",
     "strtok3": "^6.2.4",
-    "token-types": "^4.1.1"
+    "token-types": "^4.2.0"
   },
   "devDependencies": {
     "@types/chai": "^4.3.0",
     "@types/debug": "^4.1.7",
     "@types/file-type": "^10.9.1",
     "@types/mocha": "^9.1.0",
-    "@types/node": "^17.0.17",
-    "@typescript-eslint/eslint-plugin": "^5.11.0",
-    "@typescript-eslint/parser": "^5.11.0",
+    "@types/node": "^17.0.21",
+    "@typescript-eslint/eslint-plugin": "^5.12.1",
+    "@typescript-eslint/parser": "^5.12.1",
     "chai": "^4.3.6",
     "coveralls": "^3.1.1",
     "del-cli": "4.0.1",
-    "eslint": "^8.8.0",
-    "eslint-config-prettier": "^8.3.0",
+    "eslint": "^8.9.0",
+    "eslint-config-prettier": "^8.4.0",
     "eslint-import-resolver-typescript": "^2.5.0",
     "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jsdoc": "^37.8.2",
+    "eslint-plugin-jsdoc": "^37.9.4",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-unicorn": "^40.1.0",
+    "eslint-plugin-unicorn": "^41.0.0",
     "mime": "^3.0.0",
-    "mocha": "^9.2.0",
+    "mocha": "^9.2.1",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
     "remark-cli": "^10.0.1",