Merge pull request #9 from mikiymk/include-packages

Include packages

.eslintrc.json

@@ -17,7 +17,11 @@
   ],
   "ignorePatterns": [
     "dest/**/*.d.ts",
-    "**/*.js"
+    "**/*.js",
+    "test/file-type/fixture/*",
+    "test/peek-readable/resources/*",
+    "test/strtok3/resources/*",
+    "test/samples/**/*"
   ],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {

.prettierignore

@@ -0,0 +1,4 @@
+test/samples/
+test/peek-readable/resources/
+test/strtok3/resources/
+test/file-type/fixture/

lib/@tokenizer/token/index.ts

@@ -0,0 +1,30 @@
+/**
+ * Read-only token
+ * See https://github.com/Borewit/strtok3 for more information
+ */
+export interface IGetToken<V, VS extends Uint8Array = Uint8Array> {
+  /**
+   * Length of encoded token in bytes
+   */
+  len: number;
+
+  /**
+   * Decode value from buffer at offset
+   * @param array - Uint8Array to read the decoded value from
+   * @param offset - Decode offset
+   * @return decoded value
+   */
+  get(array: VS, offset: number): V;
+}
+
+export interface IToken<V, VS extends Uint8Array = Uint8Array>
+  extends IGetToken<V, VS> {
+  /**
+   * Encode value to buffer
+   * @param array - Uint8Array to write the encoded value to
+   * @param offset - Buffer write offset
+   * @param value - Value to decode of type T
+   * @return offset plus number of bytes written
+   */
+  put(array: VS, offset: number, value: V): number;
+}

lib/ParserFactory.ts

@@ -1,6 +1,6 @@
 import { IOptions, IAudioMetadata, ParserType } from "./type";
-import { ITokenizer } from "strtok3/lib/core";
-import { fileTypeFromBuffer } from "file-type/core";
+import { ITokenizer } from "./strtok3/core";
+import { fileTypeFromBuffer } from "./file-type/core";
 import * as ContentType from "content-type";
 import * as MimeType from "media-typer";
 

lib/aiff/AiffParser.ts

@@ -1,6 +1,6 @@
-import * as Token from "token-types";
+import * as Token from "../token-types";
 import initDebug from "debug";
-import * as strtok3 from "strtok3/lib/core";
+import * as strtok3 from "../strtok3/core";
 
 import { ID3v2Parser } from "../id3v2/ID3v2Parser";
 import { FourCcToken } from "../common/FourCC";

lib/aiff/AiffToken.ts

@@ -1,5 +1,5 @@
-import * as Token from "token-types";
-import { IGetToken } from "strtok3";
+import * as Token from "../token-types";
+import { IGetToken } from "../strtok3";
 
 import { FourCcToken } from "../common/FourCC";
 import * as iff from "../iff";

lib/apev2/APEv2Parser.ts

@@ -1,6 +1,6 @@
 import initDebug from "debug";
-import * as strtok3 from "strtok3/lib/core";
-import { StringType } from "token-types";
+import * as strtok3 from "../strtok3/core";
+import { StringType } from "../token-types";
 
 import * as util from "../common/Util";
 import { IOptions, IRandomReader, IApeHeader } from "../type";

lib/apev2/APEv2Token.ts

@@ -1,5 +1,5 @@
-import * as Token from "token-types";
-import { IGetToken } from "strtok3/lib/core";
+import * as Token from "../token-types";
+import { IGetToken } from "../strtok3/core";
 
 import { FourCcToken } from "../common/FourCC";
 

lib/asf/AsfObject.ts

@@ -1,10 +1,10 @@
 // ASF Objects
 
-import { IGetToken, ITokenizer } from "strtok3/lib/core";
+import { IGetToken, ITokenizer } from "../strtok3/core";
 
 import * as util from "../common/Util";
 import { IPicture, ITag } from "../type";
-import * as Token from "token-types";
+import * as Token from "../token-types";
 import GUID from "./GUID";
 import { AsfUtil } from "./AsfUtil";
 import { AttachedPictureType } from "../id3v2/ID3v2Token";

lib/asf/AsfUtil.ts

@@ -1,4 +1,4 @@
-import * as Token from "token-types";
+import * as Token from "../token-types";
 
 import * as util from "../common/Util";
 import { DataType } from "./AsfObject";

lib/common/BasicParser.ts

@@ -1,4 +1,4 @@
-import { ITokenizer } from "strtok3/lib/core";
+import { ITokenizer } from "../strtok3/core";
 
 import { ITokenParser } from "../ParserFactory";
 import { IOptions, IPrivateOptions } from "../type";

lib/common/FourCC.ts

@@ -1,5 +1,5 @@
 import * as util from "./Util";
-import { IToken } from "strtok3/lib/core";
+import { IToken } from "../strtok3/core";
 
 const validFourCC = /^[\x21-\x7e©][\x20-\x7e\x00()]{3}/;
 

lib/common/MetadataCollector.ts

@@ -16,7 +16,7 @@ import { IGenericTag, TagType, isSingleton, isUnique } from "./GenericTagTypes";
 import { CombinedTagMapper } from "./CombinedTagMapper";
 import { CommonTagMapper } from "./GenericTagMapper";
 import { toRatio } from "./Util";
-import { fileTypeFromBuffer } from "file-type/core";
+import { fileTypeFromBuffer } from "../file-type/core";
 
 const debug = initDebug("music-metadata:collector");
 

lib/core.ts

@@ -1,5 +1,5 @@
 import { Readable } from "stream";
-import * as strtok3 from "strtok3/lib/core";
+import * as strtok3 from "./strtok3/core";
 
 import { ParserFactory } from "./ParserFactory";
 import {
@@ -16,7 +16,7 @@ import { APEv2Parser } from "./apev2/APEv2Parser";
 import { hasID3v1Header } from "./id3v1/ID3v1Parser";
 import { getLyricsHeaderLength } from "./lyrics3/Lyrics3";
 
-export { IFileInfo } from "strtok3/lib/core";
+export { IFileInfo } from "./strtok3/core";
 
 /**
  * Parse audio from Node Stream.Readable

lib/dsdiff/DsdiffParser.ts

@@ -1,6 +1,6 @@
-import * as Token from "token-types";
+import * as Token from "../token-types";
 import initDebug from "debug";
-import * as strtok3 from "strtok3/lib/core";
+import * as strtok3 from "../strtok3/core";
 
 import { FourCcToken } from "../common/FourCC";
 import { BasicParser } from "../common/BasicParser";

lib/dsdiff/DsdiffToken.ts

@@ -1,5 +1,5 @@
-import * as Token from "token-types";
-import { IGetToken } from "strtok3/lib/core";
+import * as Token from "../token-types";
+import { IGetToken } from "../strtok3/core";
 
 import { FourCcToken } from "../common/FourCC";
 import { IChunkHeader64 } from "../iff";

lib/dsf/DsfChunk.ts

@@ -1,5 +1,5 @@
-import * as Token from "token-types";
-import { IGetToken } from "strtok3/lib/core";
+import * as Token from "../token-types";
+import { IGetToken } from "../strtok3/core";
 
 import { FourCcToken } from "../common/FourCC";
 

lib/file-type/browser.ts

@@ -0,0 +1,68 @@
+import { Buffer } from "node:buffer";
+import { fileTypeFromBuffer, FileTypeResult } from "./core";
+
+/**
+ * Convert Blobs to ArrayBuffer.
+ * @param blob - Web API Blob.
+ * @returns
+ */
+function blobToArrayBuffer(blob: Blob): Promise<ArrayBuffer> {
+  if (blob.arrayBuffer) {
+    return blob.arrayBuffer();
+  }
+
+  // TODO: Remove when stop supporting older environments
+  return new Promise((resolve, reject) => {
+    const fileReader = new FileReader();
+    fileReader.addEventListener("loadend", (event) => {
+      resolve(event.target.result as ArrayBuffer);
+    });
+
+    fileReader.addEventListener("error", (event) => {
+      reject(new Error(event.toString()));
+    });
+
+    fileReader.addEventListener("abort", (event) => {
+      reject(new Error(event.type));
+    });
+
+    fileReader.readAsArrayBuffer(blob);
+  });
+}
+
+/**
+ * Detect the file type of a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob).
+ *
+ * __Note:__ This method is only available in the browser.
+ * @example
+ * ```
+ * import {fileTypeFromBlob} from 'file-type';
+ *
+ * const blob = new Blob(['<?xml version="1.0" encoding="ISO-8859-1" ?>'], {
+ * 	type: 'plain/text',
+ * 	endings: 'native'
+ * });
+ *
+ * console.log(await fileTypeFromBlob(blob));
+ * //=> {ext: 'txt', mime: 'plain/text'}
+ * ```
+ */
+export async function fileTypeFromBlob(
+  blob: Blob
+): Promise<FileTypeResult | undefined> {
+  const buffer = await blobToArrayBuffer(blob);
+  return fileTypeFromBuffer(Buffer.from(buffer));
+}
+
+export {
+  fileTypeFromTokenizer,
+  fileTypeFromBuffer,
+  fileTypeStream,
+} from "./core";
+export {
+  supportedExtensions,
+  supportedMimeTypes,
+  FileTypeResult,
+  FileExtension,
+  MimeType,
+} from "./core";