add: export as binary string

EvitcaStudio · Nov 6, 2024 · 4bf01e9 · 4bf01e9
1 parent 54470ea
commit 4bf01e9
Show file tree

Hide file tree

Showing 10 changed files with 404 additions and 76 deletions.
diff --git a/docs/Frame.html b/docs/Frame.html
diff --git a/docs/Icon.html b/docs/Icon.html
diff --git a/docs/VYI.html b/docs/VYI.html
diff --git a/docs/frame.mjs.html b/docs/frame.mjs.html
diff --git a/docs/icon.mjs.html b/docs/icon.mjs.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/vyi.mjs.html b/docs/vyi.mjs.html
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "vyi",
-  "version": "1.61.0",
+  "version": "1.62.0",
   "description": "A lightweight module to read / manage .vyi files created in the Vylocity Game Engine.",
   "main": "src/vyi.mjs",
   "scripts": {

diff --git a/src/vyi.mjs b/src/vyi.mjs
@@ -58,10 +58,22 @@ class VYI {
             let vyi;
 
             if (typeof pVyiData === 'string') {
-                const isNodeEnv = typeof window === 'undefined';
-                vyi = isNodeEnv 
-                    ? await this.readFileAndGetVYI(pVyiData) 
-                    : await this.fetchAndParseJSON(pVyiData);
+                try {
+                    vyi = JSON.parse(pVyiData);
+                } catch(pError) {
+                    // Binary string
+                    if (!pVyiData.includes('.vyr') && !pVyiData.includes('.vyi')) {
+                        vyi = pVyiData;
+                        if (!vyi) {
+                            throw new Error('Non vyi data found from binary string');
+                        }
+                    } else {
+                        const isNodeEnv = typeof window === 'undefined';
+                        vyi = isNodeEnv 
+                            ? await this.readFileAndGetVYI(pVyiData) 
+                            : await this.fetchAndParseJSON(pVyiData);
+                    }
+                }
             } else if (pVyiData instanceof VYI) {
                 vyi = pVyiData.export();
             } else if (pVyiData instanceof Object && !Array.isArray(pVyiData) && !(pVyiData instanceof ArrayBuffer || pVyiData instanceof Uint8Array)) {
@@ -72,11 +84,40 @@ class VYI {
                 throw new Error('Error processing: Invalid input type provided.');
             }
 
+            if (!vyi || (!vyi.v || !vyi.i)) {
+                throw new Error('Non vyi data found.');
+            }
+
             this.processVyiData(vyi);
         } catch (pError) {
             VYI.logger.prefix('Vyi-module').error(`${pError.message}`);
         }
     }
+    /**
+     * Read the file from a binary string.
+     * @param {string} pVyiData - The compressed binary string representing the vyi data.
+     * @returns {Promise<VYI>} - An vyi that was compressed in the file.
+     */
+    readFile(pVyiData) {
+        return new Promise((pResolve, pReject) => {
+            const isNodeEnv = typeof window === 'undefined';
+            if (isNodeEnv) {
+                const data = pako.inflate(pVyiData, { to: 'string' });
+                const vyi = JSON.parse(data);
+                pResolve(vyi);
+            } else {
+                const file = new File(decompressed, 'temp');
+                const fileReader = new FileReader();
+                fileReader.readAsArrayBuffer(file);
+                fileReader.onload = (pEvent) => {
+                    pResolve(pEvent.result);
+                }
+                fileReader.onerror = (pEvent) => {
+                    pReject(new Error('Error reading file'));
+                }
+            }
+        });
+    }
     /**
      * Reads a file and returns the vyi from it.
      * @private
@@ -110,16 +151,23 @@ class VYI {
      * @returns {Object|string|null} - The parsed JSON object or decoded string, or null if it fails.
      */
     handleBinaryData(pBinaryData) {
-        const arrayBuffer = pBinaryData instanceof ArrayBuffer ? pBinaryData : pBinaryData.buffer;
-
+        const byteArray = pBinaryData instanceof ArrayBuffer ? new Uint8Array(pBinaryData) : pBinaryData;
+        
         try {
             // Attempt to decompress the binary data
-            const decompressed = pako.inflate(arrayBuffer, { to: 'string' });
+            const decompressed = pako.inflate(byteArray, { to: 'string' });
+            if (!decompressed) return null;
             return JSON.parse(decompressed);
-        } catch {
-            // If decompression fails, decode it as plain text
-            const decodedText = new TextDecoder().decode(arrayBuffer);
-            return JSON.parse(decodedText);
+        } catch (pError) {
+            // Fallback attempt to decode directly as UTF-8 string
+            try {
+                const decodedText = new TextDecoder().decode(byteArray);
+                if (!decodedText) return null;
+                return JSON.parse(decodedText);
+            } catch (pDecodeError) {
+                console.error('Decoding failed:', pDecodeError);
+                return null; // Return null if both decompression and decoding fail
+            }
         }
     }
     /**
@@ -263,12 +311,18 @@ class VYI {
     }
     /**
      * Exports this VYI into VYI format.
-     * @returns {Object} Returns the vyi data.
+     * @param {boolean} [pCompressed] - Whether the data will be compressed.
+     * @returns {Object|string} Returns the vyi data in either a binary string or an object.
      */
-    export() {
+    export(pCompressed) {
         const vyi = {};
         vyi.v = this.formatVersion;
         vyi.i = this.getIcons().map((pIcon) => pIcon.export());
+        if (pCompressed) {
+            const binaryData = new TextEncoder().encode(JSON.stringify(vyi));
+            const compressed = pako.deflate(binaryData);
+            return compressed;
+        }
         return vyi;
     }
 }