fix: Ignore all white space characters while parsing

Author: mochatek

src/constants.ts

@@ -1,23 +1,34 @@
 const CHARACTER = {
   BRACKET: {
-    OPEN: `[`,
-    CLOSE: `]`,
+    OPEN: "[",
+    CLOSE: "]",
   },
   BRACE: {
-    OPEN: `{`,
-    CLOSE: `}`,
+    OPEN: "{",
+    CLOSE: "}",
   },
-  QUOTE: `"`,
-  ESCAPE: `\\`,
+  QUOTE: '"',
+  ESCAPE: "\\",
   SPACE: " ",
   COMMA: ",",
+  TAB: "\t",
+  CARRIAGE_RETURN: "\r",
   NEW_LINE: "\n",
+  ZERO_WIDTH_NO_BREAK_SPACE: "\uFEFF",
 };
 
+const WHITESPACE_CHARACTERS = [
+  CHARACTER.SPACE,
+  CHARACTER.TAB,
+  CHARACTER.NEW_LINE,
+  CHARACTER.CARRIAGE_RETURN,
+  CHARACTER.ZERO_WIDTH_NO_BREAK_SPACE,
+];
+
 const ERRORS = {
   INVALID_FILE: "Invalid JSON array file",
   INVALID_ELEMENT: (element: string) =>
     `Invalid element found in JSON array - ${element}`,
 };
 
-export { CHARACTER, ERRORS };
+export { CHARACTER, WHITESPACE_CHARACTERS, ERRORS };

src/modules/JsonArrayAppend.ts

@@ -1,5 +1,5 @@
 import { stat, open, FileHandle } from "fs/promises";
-import { CHARACTER, ERRORS } from "../constants";
+import { CHARACTER, ERRORS, WHITESPACE_CHARACTERS } from "../constants";
 
 const appendToJsonArray = async (
   filePath: string,
@@ -28,9 +28,7 @@ const appendToJsonArray = async (
           insertPosition +=
             i === 0 ? 0 : Buffer.byteLength(windowValue.slice(0, i), encoding);
           break searchForArrayEnd;
-        } else if (
-          ![CHARACTER.NEW_LINE, CHARACTER.SPACE].includes(windowValue[i])
-        ) {
+        } else if (!WHITESPACE_CHARACTERS.includes(windowValue[i])) {
           throw new Error(ERRORS.INVALID_FILE);
         }
       }
@@ -55,7 +53,7 @@ const appendToJsonArray = async (
         const windowValue = window.toString(encoding);
 
         for (let i = windowValue.length - 1; i >= 0; i--) {
-          if (![CHARACTER.NEW_LINE, CHARACTER.SPACE].includes(windowValue[i])) {
+          if (!WHITESPACE_CHARACTERS.includes(windowValue[i])) {
             if (windowValue[i] !== CHARACTER.BRACKET.OPEN) {
               insertData = `,${insertData}`;
             }

src/modules/JsonArrayStreamer.ts

@@ -2,7 +2,7 @@ import { createReadStream } from "fs";
 import { Readable } from "stream";
 import { once } from "events";
 import type { ElementType, ReadStreamOptions } from "../index.types";
-import { CHARACTER, ERRORS } from "../constants";
+import { CHARACTER, ERRORS, WHITESPACE_CHARACTERS } from "../constants";
 
 class JsonArrayStreamer<T> {
   private readStream: Readable | null;
@@ -40,7 +40,7 @@ class JsonArrayStreamer<T> {
     if (!this.readStream) throw new Error("Stream not initialized");
 
     for await (const chunk of this.readStream) {
-      yield chunk;
+      yield chunk as string;
     }
   }
 
@@ -144,11 +144,7 @@ class JsonArrayStreamer<T> {
         for (let char of chunk) {
           if (!this.rootDetected) {
             if (
-              ![
-                CHARACTER.SPACE,
-                CHARACTER.NEW_LINE,
-                CHARACTER.BRACKET.OPEN,
-              ].includes(char)
+              ![...WHITESPACE_CHARACTERS, CHARACTER.BRACKET.OPEN].includes(char)
             )
               throw new Error(ERRORS.INVALID_FILE);
 
@@ -159,11 +155,7 @@ class JsonArrayStreamer<T> {
           if (!this.elementDetected) {
             if (char === CHARACTER.BRACKET.CLOSE) break characterStream;
 
-            this.elementDetected = ![
-              CHARACTER.SPACE,
-              CHARACTER.COMMA,
-              CHARACTER.NEW_LINE,
-            ].includes(char);
+            this.elementDetected = !WHITESPACE_CHARACTERS.includes(char);
           }
 
           if (this.elementDetected) {

src/modules/JsonArrayTransformer.ts

@@ -1,5 +1,5 @@
 import { Transform, TransformCallback } from "stream";
-import { CHARACTER } from "../constants";
+import { CHARACTER, WHITESPACE_CHARACTERS } from "../constants";
 
 class JsonArrayStreamer<T> extends Transform {
   private encoding: BufferEncoding;
@@ -126,11 +126,7 @@ class JsonArrayStreamer<T> extends Transform {
       for (let char of decodedString) {
         if (!this.rootDetected) {
           if (
-            ![
-              CHARACTER.SPACE,
-              CHARACTER.NEW_LINE,
-              CHARACTER.BRACKET.OPEN,
-            ].includes(char)
+            ![...WHITESPACE_CHARACTERS, CHARACTER.BRACKET.OPEN].includes(char)
           ) {
             throw new Error("Invalid file structure");
           }
@@ -141,11 +137,7 @@ class JsonArrayStreamer<T> extends Transform {
 
         if (!this.elementDetected) {
           if (char === CHARACTER.BRACKET.CLOSE) break;
-          this.elementDetected = ![
-            CHARACTER.SPACE,
-            CHARACTER.COMMA,
-            CHARACTER.NEW_LINE,
-          ].includes(char);
+          this.elementDetected = !WHITESPACE_CHARACTERS.includes(char);
         }
 
         if (this.elementDetected) {