@turbowarp/sb3fix 0.1.0 → 0.1.1

package/README.md

@@ -22,11 +22,17 @@ const run = async () => {
   const projectData = fs.readFileSync('your-broken-project.sb3');
   const result = await sb3fix(projectData); // projectData can be ArrayBuffer, Uint8Array-like, Blob, or File
 
-  const fixedZip = result.fixedZip; // fixedZip is ArrayBuffer
-  const log = result.log; // log is Array of strings
+  console.log(result);
 
-  // sb3fix is deterministic: the same input project always produces the same zip and log
-  // If the zip cannot be fixed, the Promise returned by sb3fix() will reject. You should handle this.
+  const success = result.success; // success is boolean
+  if (success) {
+    const fixedZip = result.fixedZip; // fixedZip is ArrayBuffer
+    const log = result.log; // log is Array of strings
+  } else {
+    const error = result.error; // error is any type (probably an Error, but not necessarily)
+  }
+
+  // sb3fix is deterministic: the same input project always produces the same output
 };
 
 run();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turbowarp/sb3fix",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Fix corrupted Scratch projects",
   "main": "src/sb3fix.js",
   "scripts": {

package/src/sb3fix.js

@@ -43,7 +43,7 @@ const BUILTIN_EXTENSIONS = [
 
 /**
  * @param {ArrayBuffer|Uint8Array|Blob} data
- * @returns {Promise<{log: string[], fixedZip: ArrayBuffer}>} fixed compressed sb3
+ * @returns {Promise<{success: boolean; fixedZip: ArrayBuffer; log: string[]; error?: unknown;}>} fixed compressed sb3
  */
 const sb3fix = async (data) => {
   const logMessages = [];