@turbowarp/sb3fix 0.3.7 → 0.5.0

package/src/sb3fix.js

@@ -1,606 +1,794 @@
-/*!
-sb3fix - https://github.com/TurboWarp/sb3fix
-
-Copyright (C) 2023-2025 Thomas Weber
-
-This Source Code Form is subject to the terms of the Mozilla Public
-License, v. 2.0. If a copy of the MPL was not distributed with this
-file, You can obtain one at https://mozilla.org/MPL/2.0/.
-*/
-
-/**
- * @typedef Options
- * @property {(message: string) => void} [logCallback]
- */
-
-/**
- * @param {unknown} obj
- * @returns {obj is object}
- */
-const isObject = (obj) => !!obj && typeof obj === 'object';
-
-const BUILTIN_EXTENSIONS = [
-  'control',
-  'data',
-  'event',
-  'looks',
-  'motion',
-  'operators',
-  'procedures',
-  'argument', // "argument_reporter_boolean" is technically not an extension but we should list here anyways
-  'sensing',
-  'sound',
-  'pen',
-  'wedo2',
-  'music',
-  'microbit',
-  'text2speech',
-  'translate',
-  'videoSensing',
-  'ev3',
-  'makeymakey',
-  'boost',
-  'gdxfor'
-  // intentionally not listing TurboWarp's 'tw' extension here.
-];
-
-/**
- * @param {object} project Parsed project.json.
- * @returns {Set<string>} Set of valid extensions, including the primitive ones, that the project loads.
- */
-const getKnownExtensions = (project) => {
-  const extensions = project.extensions;
-  if (!Array.isArray(extensions)) {
-    throw new Error('extensions is not an array');
-  }
-  for (let i = 0; i < extensions.length; i++) {
-    if (typeof extensions[i] !== 'string') {
-      throw new Error(`extension ${i} is not a string`);
-    }
-  }
-  return new Set([
-    ...BUILTIN_EXTENSIONS,
-    ...extensions
-  ]);
-};
-
-/**
- * @param {string|object} data project.json as a string or as a parsed object already. If object provided, it will be modified in-place.
- * @param {Options} [options]
- * @returns {object} Fixed project.json object. If the `data` argument was an object, this will point to the same object.
- */
-const fixJSON = (data, options = {}) => {
-  /**
-   * @param {string} message
-   */
-  const log = (message) => {
-    if (options.logCallback) {
-      options.logCallback(message);
-    }
-  };
-
-  /**
-   * @param {string} id
-   * @param {unknown} variable
-   */
-  const fixVariableInPlace = (id, variable) => {
-    if (!Array.isArray(variable)) {
-      throw new Error(`variable object ${id} is not an array`);
-    }
-
-    const name = variable[0];
-    if (typeof name !== 'string') {
-      log(`variable or list ${id} name was not a string`);
-      variable[0] = String(variable[0]);
-    }
-
-    const value = variable[1];
-    if (typeof value !== 'number' && typeof value !== 'string' && typeof value !== 'boolean') {
-      log(`variable ${id} value was not a Scratch-compatible value`);
-      variable[1] = String(variable[1]);
-    }
-  };
-
-  /**
-   * @param {string} id
-   * @param {unknown} list
-   */
-  const fixListInPlace = (id, list) => {
-    if (!Array.isArray(list)) {
-      throw new Error(`list object ${id} is not an array`);
-    }
-
-    const name = list[0];
-    if (typeof name !== 'string') {
-      log(`list ${id} name was not a string`);
-      list[0] = String(list[0]);
-    }
-
-    if (!Array.isArray(list[1])) {
-      log(`list ${id} value was not an array`);
-      list[1] = [];
-    }
-
-    const listValue = list[1];
-    for (let i = 0; i < listValue.length; i++) {
-      const value = listValue[i];
-      if (typeof value !== 'number' && typeof value !== 'string' && typeof value !== 'boolean') {
-        log(`list ${id} index ${i} was not a Scratch-compatible value`);
-        listValue[i] = String(value);
-      }
-    }
-  };
-
-  /**
-   * @param {unknown[]} native
-   */
-  const fixCompressedNativeInPlace = (native) => {
-    if (!Array.isArray(native)) {
-      throw new Error('native is not an array');
-    }
-
-    const type = native[0];
-    if (typeof type !== 'number') {
-      throw new Error('native type is not a number');
-    }
-
-    switch (type) {
-      // Number primitive: [4, string|number]
-      // Positive number primitive: [5, string|number]
-      // Whole number primitive: [6, string|number]
-      // Integer primitive: [7, string|number]
-      // Angle primitive: [8, string|number]
-      case 4:
-      case 5:
-      case 6:
-      case 7:
-      case 8: {
-        if (native.length !== 2) {
-          throw new Error(`Number native is of unexpected length: ${native.length}`);
-        }
-        const value = native[1];
-        if (typeof value !== 'string' && typeof value !== 'number') {
-          log('number native had invalid value');
-          native[1] = String(value);
-        }
-        break;
-      }
-
-      // Color: [9, hex color]
-      case 9: {
-        if (native.length !== 2) {
-          throw new Error(`Color native is of unexpected length: ${native.length}`);
-        }
-        const color = native[1];
-        if (typeof color !== 'string' || !/^#[a-f0-9]{6}$/i.test(color)) {
-          log('color native had invalid value');
-          native[1] = '#000000';
-        }
-        break;
-      }
-
-      // Text: [10, string|number]
-      case 10: {
-        if (native.length !== 2) {
-          throw new Error(`Text native is of unexpected length: ${native.length}`);
-        }
-        const value = native[1];
-        if (typeof value !== 'string' && typeof value !== 'number') {
-          log('text native had invalid value');
-          native[1] = String(value);
-        }
-        break;
-      }
-
-      // Variable: [12, variable name, variable id, x?, y?]
-      // List: [13, list name, list id, x?, y?]
-      // x and y only present if the native is a top-level block
-      case 12:
-      case 13: {
-        if (native.length !== 3 && native.length !== 5) {
-          throw new Error(`Variable or list native is of unexpected length: ${native.length}`);
-        }
-        const name = native[1];
-        if (typeof name !== 'string') {
-          log(`variable or list native name was not a string`);
-          native[1] = String(native[1]);
-        }
-        break;
-      }
-    }
-  };
-
-  /**
-   * @param {string} id
-   * @param {unknown} block
-   */
-  const fixBlockInPlace = (id, block) => {
-    if (Array.isArray(block)) {
-      fixCompressedNativeInPlace(block);
-    } else if (isObject(block)) {
-      const inputs = block.inputs;
-      if (!isObject(inputs)) {
-        throw new Error('inputs is not an object');
-      }
-      for (const [inputName, input] of Object.entries(inputs)) {
-        if (!Array.isArray(input)) {
-          throw new Error(`block ${id} input ${inputName} is not an array`);
-        }
-        for (let i = 1; i < input.length; i++) {
-          if (Array.isArray(input[i])) {
-            fixCompressedNativeInPlace(input[i]);
-          }
-        }
-      }
-
-      const fields = block.fields;
-      if (!isObject(fields)) {
-        throw new Error('fields is not an object');
-      }
-      for (const [fieldName, field] of Object.entries(fields)) {
-        if (!Array.isArray(field)) {
-          throw new Error(`block ${id} field ${fieldName} is not an array`);
-        }
-      }
-    } else {
-      throw new Error(`block ${id} is not an object`);
-    }
-  };
-
-  /**
-   * @param {string} id
-   * @param {unknown} comment
-   */
-  const fixCommentInPlace = (id, comment) => {
-    if (!isObject(comment)) {
-      throw new Error('comment is not an object');
-    }
-
-    if (typeof comment.text !== 'string') {
-      throw new Error('comment text is not a string');
-    }
-
-    // Scratch requires comments to not exceed 8000 characters.
-    // We'll store the excess in .extraText so the text won't be truncated if opened in TurboWarp.
-    const MAX_LENGTH = 8000;
-    if (comment.text.length > MAX_LENGTH) {
-      log(`comment ${id} had length ${comment.text.length}`);
-      comment.extraText = comment.text.substring(MAX_LENGTH);
-      comment.text = comment.text.substring(0, MAX_LENGTH);
-    }
-  };
-
-  /**
-   * @param {unknown} target
-   */
-  const fixTargetInPlace = (target) => {
-    const costumes = target.costumes;
-    if (!Array.isArray(costumes)) {
-      throw new Error('costumes is not an array');
-    }
-    for (let i = costumes.length - 1; i >= 0; i--) {
-      const costume = costumes[i];
-      if (!isObject(costume)) {
-        throw new Error(`costume ${i} is not an object`);
-      }
-
-      if (typeof costume.name !== 'string') {
-        log(`costume ${i} name was not a string`);
-        costume.name = String(costume.name);
-      }
-
-      // https://github.com/scratchfoundation/scratch-parser/blob/665f05d739a202d565a4af70a201909393d456b2/lib/sb3_definitions.json#L51
-      const knownCostumeFormats = ['png', 'svg', 'jpeg', 'jpg', 'bmp', 'gif'];
-      if (!knownCostumeFormats.includes(costume.dataFormat)) {
-        if (typeof costume.md5ext === 'string' && costume.md5ext.endsWith('.svg')) {
-          log(`costume ${i} is vector, had invalid dataFormat ${costume.dataFormat}`);
-          costume.dataFormat = 'svg';
-        } else {
-          log(`costume ${i} is bitmap, had invalid dataFormat ${costume.dataFormat}`);
-          // dataFormat is only really used to detect vector or bitmap, so we don't
-          // need to set this to the real format
-          costume.dataFormat = 'png';
-        }
-      }
-
-      if (!('assetId' in costume)) {
-        log(`costume ${i} was missing assetId, deleted`);
-        costumes.splice(i, 1);
-      }
-    }
-    if (costumes.length === 0) {
-      log(`costumes was empty, adding empty costume`);
-      costumes.push({
-        // Empty SVG costume
-        name: 'costume1',
-        bitmapResolution: 1,
-        dataFormat: 'svg',
-        assetId: 'cd21514d0531fdffb22204e0ec5ed84a',
-        md5ext: 'cd21514d0531fdffb22204e0ec5ed84a.svg',
-        rotationCenterX: 0,
-        rotationCenterY: 0
-      });
-    }
-
-    const sounds = target.sounds;
-    if (!Array.isArray(sounds)) {
-      throw new Error('sounds is not an array');
-    }
-    for (let i = sounds.length - 1; i >= 0; i--) {
-      const sound = sounds[i];
-      if (!isObject(sound)) {
-        throw new Error(`sound ${i} is not an object`);
-      }
-
-      // https://github.com/scratchfoundation/scratch-parser/blob/665f05d739a202d565a4af70a201909393d456b2/lib/sb3_definitions.json#L81
-      const knownSoundFormats = ['wav', 'wave', 'mp3'];
-      if (!knownSoundFormats.includes(sound.dataFormat)) {
-        log(`sound ${i} had invalid dataFormat ${sound.dataFormat}`);
-        sound.dataFormat = 'mp3';
-      }
-
-      if (typeof sound.name !== 'string') {
-        log(`sound ${i} name was not a string`);
-        sound.name = String(sound.name);
-      }
-
-      if (!('assetId' in sound)) {
-        log(`sound ${i} was missing assetId, deleted`);
-        sounds.splice(i, 1);
-      }
-    }
-
-    const blocks = target.blocks;
-    if (!isObject(blocks)) {
-      throw new Error('blocks is not an object');
-    }
-    for (const [blockId, block] of Object.entries(blocks)) {
-      fixBlockInPlace(blockId, block);
-    }
-
-    // Comments are not required
-    const comments = target.comments;
-    if (comments) {
-      for (const [commentId, comment] of Object.entries(comments)) {
-        fixCommentInPlace(commentId, comment);
-      }
-    }
-
-    const variables = target.variables;
-    if (!isObject(variables)) {
-      throw new Error('variables is not an object');
-    }
-    for (const [variableId, variable] of Object.entries(variables)) {
-      fixVariableInPlace(variableId, variable);
-    }
-
-    const lists = target.lists;
-    if (!isObject(lists)) {
-      throw new Error('lists is not an object');
-    }
-    for (const [listId, list] of Object.entries(lists)) {
-      fixListInPlace(listId, list);
-    }
-
-    if (target.isStage) {
-      if (target.layerOrder !== 0) {
-        log('stage had invalid layerOrder');
-        target.layerOrder = 0;
-      }
-    } else {
-      if (target.layerOrder < 1) {
-        log('sprite had invalid layerOrder');
-        target.layerOrder = 1;
-      }
-    }
-
-    const ROTATION_STYLES = [
-      'all around',
-      'don\'t rotate',
-      'left-right'
-    ];
-    if (!target.isStage && !ROTATION_STYLES.includes(target.rotationStyle)) {
-      log(`sprite had invalid rotation style ${target.rotationStyle}`);
-      target.rotationStyle = 'all around';
-    }
-
-    if (!target.isStage) {
-      const x = target.x;
-      if (typeof x !== 'number') {
-        log(`target x was ${typeof x}: ${x}`);
-        target.x = +x || 0;
-      }
-  
-      const y = target.y;
-      if (typeof y !== 'number') {
-        log(`target y was ${typeof y}: ${y}`);
-        target.y = +y || 0;
-      }
-    }
-  };
-
-  /**
-   * @param {unknown} stage
-   */
-  const fixStageInPlace = (stage) => {
-    // stage's name must match exactly
-    if (stage.name !== 'Stage') {
-      log(`stage had wrong name: ${stage.name}`);
-      stage.name = 'Stage';
-    }
-
-    // In vanilla Scratch, "turn video < ... >" with anything that isn't the dropdown allows videoState
-    // to be set to something that isn't one of the expected strings. We'll play it safe and default to
-    // off.
-    const VIDEO_STATES = [
-      'on',
-      'off',
-      'on-flipped'
-    ];
-    if (Object.prototype.hasOwnProperty.call(stage, 'videoState') && !VIDEO_STATES.includes(stage.videoState)) {
-      log(`stage had invalid videoState: ${stage.videoState}`);
-      stage.videoState = 'off';
-    }
-  };
-
-  /**
-   * @param {unknown} project
-   */
-  const fixProjectInPlace = (project) => {
-    if ('objName' in project) {
-      throw new Error('Scratch 2 (sb2) projects not supported');
-    }
-
-    if (!isObject(project)) {
-      throw new Error('Root JSON is not an object');
-    }
-
-    if ('name' in project) {
-      // Not a project. Just a sprite.
-      log('project is a sprite');
-      fixTargetInPlace(project);
-      return;
-    }
-
-    const targets = project.targets;
-    if (!Array.isArray(targets)) {
-      throw new Error('targets is not an array');
-    }
-    if (targets.length < 1) {
-      throw new Error('targets is empty');
-    }
-    for (let i = 0; i < targets.length; i++) {
-      log(`checking target ${i}`);
-      const target = targets[i];
-      if (!isObject(target)) {
-        throw new Error('target is not an object');
-      }
-      fixTargetInPlace(target);
-    }
-
-    const allStages = targets.filter((target) => target.isStage);
-    if (allStages.length === 0) {
-      log('stage is missing; adding an empty one');
-      targets.unshift({
-        isStage: true,
-        name: 'Stage',
-        variables: {},
-        lists: {},
-        broadcasts: {},
-        blocks: {},
-        currentCostume: 0,
-        costumes: [
-          {
-            name: 'backdrop1',
-            dataFormat: 'svg',
-            assetId: 'cd21514d0531fdffb22204e0ec5ed84a',
-            md5ext: 'cd21514d0531fdffb22204e0ec5ed84a.svg',
-            rotationCenterX: 240,
-            rotationCenterY: 180
-          }
-        ],
-        sounds: [],
-        volume: 100,
-        layerOrder: 0,
-        tempo: 60,
-        videoTransparency: 50,
-        videoState: "on",
-        textToSpeechLanguage: null
-      });
-    } else {
-      // We will accept the first stage in targets as the real stage
-      const firstStageIndex = targets.findIndex((target) => target.isStage);
-
-      // Stage must be the first target
-      if (firstStageIndex !== 0) {
-        log(`stage was at wrong index: ${firstStageIndex}`);
-        const stage = targets[firstStageIndex];
-        targets.splice(firstStageIndex, 1);
-        targets.unshift(stage);
-      }
-
-      // Remove all the other stages
-      for (let i = targets.length - 1; i > 0; i--) {
-        if (targets[i].isStage) {
-          log(`removing extra stage at index ${i}`);
-          targets.splice(i, 1);
-        }
-      }
-    }
-
-    // Above checks ensure this invariant holds
-    const stage = targets[0];
-    fixStageInPlace(stage);
-
-    const knownExtensions = getKnownExtensions(project);
-    const monitors = project.monitors;
-    if (!Array.isArray(monitors)) {
-      throw new Error('monitors is not an array');
-    }
-    project.monitors = project.monitors.filter((monitor, i) => {
-      const opcode = monitor.opcode;
-      if (typeof opcode !== 'string') {
-        throw new Error(`monitor ${i} opcode is not a string`);
-      }
-      const extension = opcode.split('_')[0];
-      if (!knownExtensions.has(extension)) {
-        log(`removed monitor ${i} from unknown extension ${extension}`);
-        return false;
-      }
-      return true;
-    });
-  };
-
-  if (typeof data === 'object' && data !== null) {
-    // Already parsed.
-    fixProjectInPlace(data);
-    return data;
-  } else if (typeof data === 'string') {
-    // Need to parse.
-    const parsed = JSON.parse(data);
-    fixProjectInPlace(parsed);
-    return parsed;
-  } else {
-    throw new Error('Unable to tell how to interpret input as JSON');
-  }
-};
-
-/**
- * @param {ArrayBuffer|Uint8Array|Blob} data A compressed .sb3 file.
- * @param {Options} [options]
- * @returns {Promise<ArrayBuffer>} A promise that resolves to a fixed compressed .sb3 file.
- */
-const fixZip = async (data, options = {}) => {
-  // JSZip is not a small library, so we'll load it somewhat lazily.
-  const JSZip = require('@turbowarp/jszip');
-
-  const zip = await JSZip.loadAsync(data);
-
-  // json is not guaranteed to be stored in the root.
-  const jsonFile = zip.file(/(?:project|sprite)\.json/)[0];
-  if (!jsonFile) {
-    throw new Error('Could not find project.json or sprite.json.');
-  }
-
-  const jsonText = await jsonFile.async('text');
-  const fixedJSON = fixJSON(jsonText, options);
-  const newProjectJSONText = JSON.stringify(fixedJSON);
-  zip.file(jsonFile.name, newProjectJSONText);
-
-  // By default, JSZip will use the current date as the modified timestamp, which would generated zips non-deterministic.
-  const date = new Date('Thu, 14 Mar 2024 00:00:00 GMT');
-  for (const file of Object.values(zip.files)) {
-    file.date = date;
-  }
-
-  const compressed = await zip.generateAsync({
-    type: 'uint8array',
-    compression: 'DEFLATE'
-  });
-  return compressed;
-};
-
-module.exports = {
-  fixJSON,
-  fixZip
-};
+/*!
+sb3fix - https://github.com/TurboWarp/sb3fix
+
+Copyright (C) 2023-2025 Thomas Weber
+
+This Source Code Form is subject to the terms of the Mozilla Public
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, You can obtain one at https://mozilla.org/MPL/2.0/.
+*/
+
+/**
+ * @typedef {'scratch'|'turbowarp'} Platform
+ */
+
+/**
+ * @typedef Options
+ * @property {Platform} [platform] Defaults to 'scratch'.
+ * @property {(message: string) => void} [logCallback]
+ */
+
+/**
+ * @param {unknown} obj
+ * @returns {obj is object}
+ */
+const isObject = (obj) => !!obj && typeof obj === 'object';
+
+/**
+ * Object.hasOwn() but it works in more browsers.
+ * @param {unknown} obj 
+ * @param {string} property 
+ * @returns {boolean} true if Object.hasOwn(obj, property)
+ */
+const hasOwn = (obj, property) => Object.prototype.hasOwnProperty.call(obj, property);
+
+/**
+ * @typedef PlatformInfo
+ * @property {boolean} [allowsNonScalarVariables] If true, variables don't need to be a single string/number/boolean.
+ * @property {boolean} [nativelyUnderstandsSpork] If true, the platform's editor can natively understand spork-isms in project.json and thus compatibility fixes can be skipped.
+ */
+
+/**
+ * @type {Record<Platform, PlatformInfo>}
+ */
+const platforms = {
+  scratch: {
+    // Although the Scratch website uses spork, the desktop app still doesn't so for now, we'll keep applying the spork fixes there too.
+    nativelyUnderstandsSpork: false,
+    allowsNonScalarVariables: false
+  },
+  turbowarp: {
+    nativelyUnderstandsSpork: false,
+    allowsNonScalarVariables: true
+  }
+};
+
+/**
+ * @param {Options} options
+ * @returns {PlatformInfo}
+ */
+const getPlatform = (options) => {
+  if (options && hasOwn(options, 'platform')) {
+    if (hasOwn(platforms, options.platform)) {
+      return platforms[options.platform];
+    }
+    throw new Error(`Unknown platform: ${options.platform}`);
+  }
+  return platforms.scratch;
+};
+
+const BUILTIN_EXTENSIONS = [
+  'control',
+  'data',
+  'event',
+  'looks',
+  'motion',
+  'operators',
+  'procedures',
+  'argument', // "argument_reporter_boolean" is technically not an extension but we should list here anyways
+  'sensing',
+  'sound',
+  'pen',
+  'wedo2',
+  'music',
+  'microbit',
+  'text2speech',
+  'translate',
+  'videoSensing',
+  'ev3',
+  'makeymakey',
+  'boost',
+  'gdxfor'
+  // intentionally not listing TurboWarp's 'tw' extension here.
+];
+
+/**
+ * @param {object} project Parsed project.json.
+ * @returns {Set<string>} Set of valid extensions, including the primitive ones, that the project loads.
+ */
+const getKnownExtensions = (project) => {
+  const extensions = project.extensions;
+  if (!Array.isArray(extensions)) {
+    throw new Error('extensions is not an array');
+  }
+  for (let i = 0; i < extensions.length; i++) {
+    if (typeof extensions[i] !== 'string') {
+      throw new Error(`extension ${i} is not a string`);
+    }
+  }
+  return new Set([
+    ...BUILTIN_EXTENSIONS,
+    ...extensions
+  ]);
+};
+
+/**
+ * @param {string|object} data project.json as a string or as a parsed object already. If object provided, it will be modified in-place.
+ * @param {Options} [options]
+ * @returns {object} Fixed project.json object. If the `data` argument was an object, this will point to the same object.
+ */
+const fixJSON = (data, options = {}) => {
+  const platform = getPlatform(options);
+
+  /**
+   * @param {string} message
+   */
+  const log = (message) => {
+    if (options.logCallback) {
+      options.logCallback(message);
+    }
+  };
+
+  /**
+   * @param {string} id
+   * @param {unknown} variable
+   */
+  const fixVariableInPlace = (id, variable) => {
+    if (!Array.isArray(variable)) {
+      throw new Error(`variable object ${id} is not an array`);
+    }
+
+    const name = variable[0];
+    if (typeof name !== 'string') {
+      log(`variable or list ${id} name was not a string`);
+      variable[0] = String(variable[0]);
+    }
+
+    if (!platform.allowsNonScalarVariables) {
+      const value = variable[1];
+      if (typeof value !== 'number' && typeof value !== 'string' && typeof value !== 'boolean') {
+        log(`variable ${id} value was not a Scratch-compatible value`);
+        variable[1] = String(variable[1]);
+      }
+    }
+  };
+
+  /**
+   * @param {string} id
+   * @param {unknown} list
+   */
+  const fixListInPlace = (id, list) => {
+    if (!Array.isArray(list)) {
+      throw new Error(`list object ${id} is not an array`);
+    }
+
+    const name = list[0];
+    if (typeof name !== 'string') {
+      log(`list ${id} name was not a string`);
+      list[0] = String(list[0]);
+    }
+
+    if (!Array.isArray(list[1])) {
+      log(`list ${id} value was not an array`);
+      list[1] = [];
+    }
+
+    const listValue = list[1];
+    for (let i = 0; i < listValue.length; i++) {
+      const value = listValue[i];
+      if (typeof value !== 'number' && typeof value !== 'string' && typeof value !== 'boolean') {
+        log(`list ${id} index ${i} was not a Scratch-compatible value`);
+        listValue[i] = String(value);
+      }
+    }
+  };
+
+  /**
+   * @param {unknown[]} native
+   * @returns {boolean} true to keep, false to delete
+   */
+  const fixCompressedNativeInPlace = (native) => {
+    if (!Array.isArray(native)) {
+      throw new Error('native is not an array');
+    }
+
+    const type = native[0];
+    if (typeof type !== 'number') {
+      throw new Error('native type is not a number');
+    }
+
+    switch (type) {
+      // Number primitive: [4, string|number]
+      // Positive number primitive: [5, string|number]
+      // Whole number primitive: [6, string|number]
+      // Integer primitive: [7, string|number]
+      // Angle primitive: [8, string|number]
+      case 4:
+      case 5:
+      case 6:
+      case 7:
+      case 8: {
+        if (native.length !== 2) {
+          throw new Error(`Number native is of unexpected length: ${native.length}`);
+        }
+        const value = native[1];
+        if (typeof value !== 'string' && typeof value !== 'number') {
+          log('number native had invalid value');
+          native[1] = String(value);
+        }
+        return true;
+      }
+
+      // Color: [9, hex color]
+      case 9: {
+        if (native.length !== 2) {
+          throw new Error(`Color native is of unexpected length: ${native.length}`);
+        }
+        const color = native[1];
+        if (typeof color !== 'string' || !/^#[a-f0-9]{6}$/i.test(color)) {
+          log('color native had invalid value');
+          native[1] = '#000000';
+        }
+        return true;
+      }
+
+      // Text: [10, string|number]
+      case 10: {
+        if (native.length !== 2) {
+          throw new Error(`Text native is of unexpected length: ${native.length}`);
+        }
+        const value = native[1];
+        if (typeof value !== 'string' && typeof value !== 'number') {
+          log('text native had invalid value');
+          native[1] = String(value);
+        }
+        return true;
+      }
+
+      // Broadcast: [11, name, id]
+      case 11: {
+        if (native.length !== 3) {
+          throw new Error(`Broadcast native is of unexpected length: ${native.length}`);
+        }
+        const name = native[1];
+        if (typeof name !== 'string') {
+          log(`broadcast native name was not a string`);
+          native[1] = String(native[1]);
+        }
+        const id = native[2];
+        if (typeof id !== 'string') {
+          log(`deleting compressed broadcast reference with non-string ID`);
+          return false;
+        }
+        return true;
+      }
+
+      // Variable: [12, variable name, variable id, x?, y?]
+      // List: [13, list name, list id, x?, y?]
+      // x and y only present if the native is a top-level block
+      case 12:
+      case 13: {
+        if (native.length !== 3 && native.length !== 5) {
+          throw new Error(`Variable or list native is of unexpected length: ${native.length}`);
+        }
+        const name = native[1];
+        if (typeof name !== 'string') {
+          log(`variable or list native name was not a string`);
+          native[1] = String(native[1]);
+        }
+        const id = native[2];
+        if (typeof id !== 'string') {
+          log(`deleting compressed variable or list reference with non-string ID`);
+          return false;
+        }
+        return true;
+      }
+
+      default:
+        throw new Error(`Unknown native type: ${type}`);
+    }
+  };
+
+  /**
+   * @param {string} id
+   * @param {unknown} block
+   * @returns {boolean} true to keep, false to delete
+   */
+  const fixBlockInPlace = (id, block) => {
+    if (Array.isArray(block)) {
+      return fixCompressedNativeInPlace(block);
+    } else if (isObject(block)) {
+      const inputs = block.inputs;
+      if (!isObject(inputs)) {
+        throw new Error('inputs is not an object');
+      }
+      for (const [inputName, input] of Object.entries(inputs)) {
+        if (!Array.isArray(input)) {
+          throw new Error(`block ${id} input ${inputName} is not an array`);
+        }
+        for (let i = 1; i < input.length; i++) {
+          if (Array.isArray(input[i])) {
+            if (!fixCompressedNativeInPlace(input[i])) {
+              // Logging happens in fixCompressedNativeInPlace
+              input[i] = null;
+            }
+          }
+        }
+      }
+
+      const fields = block.fields;
+      if (!isObject(fields)) {
+        throw new Error('fields is not an object');
+      }
+      for (const [fieldName, field] of Object.entries(fields)) {
+        if (!Array.isArray(field)) {
+          throw new Error(`block ${id} field ${fieldName} is not an array`);
+        }
+      }
+
+      return true;
+    } else {
+      throw new Error(`block ${id} is not an object`);
+    }
+  };
+
+  /**
+   * Fix backwards-incompatible changes that Scratch made in the spork migration.
+   * @param {object} blocks
+   */
+  const fixSporkBackwardsIncompatibilityInPlace = (blocks) => {
+    for (const [blockId, block] of Object.entries(blocks)) {
+      if (!isObject(block)) {
+        continue;
+      }
+
+      switch (block.opcode) {
+        // Custom block definition prototype blocks used to be marked as shadow: true, but spork marks as shadow: false.
+        // Our scratch-blocks relies on it being shadow: true to prevent moving, so we'll force it to be that way.
+        case 'procedures_prototype':
+          if (block.shadow !== true) {
+            log(`(spork) forcing shadow on procedures_prototype block ${blockId}`);
+            block.shadow = true;
+          }
+          break;
+
+        // For completeness with the above, set the argument reporter generators to be shadow: true as well.
+        case 'argument_reporter_string_number':
+        case 'argument_reporter_boolean': {
+          const parent = blocks[block.parent];
+          if (isObject(parent) && parent.opcode === 'procedures_prototype' && block.shadow !== true) {
+            log(`(spork) forcing shadow on ${block.opcode} block ${blockId}`);
+            block.shadow = true;
+          }
+          break;
+        }
+
+        // control_stop used to define a mutation for whether it has a connection below, which is what old
+        // scratch-blocks relies on to determine if there is another conneciton below or not. Spork does not define
+        // this mutation and relies only on the STOP_OPTION field. We will generate the mutation if it's missing so
+        // that a "stop other scripts in sprite" block doesn't cause the workspace to fail to load.
+        case 'control_stop': {
+          if (!block.mutation) {
+            const field = block.fields && block.fields.STOP_OPTION;
+            const stopOption = Array.isArray(field) ? field[0] : null;
+            const hasNext = stopOption === 'other scripts in sprite' || stopOption === 'other scripts in stage';
+            if (hasNext) {
+              log(`(spork) generating mutation on control_stop block ${blockId}`);
+              block.mutation = {
+                tagName: 'mutation',
+                hasnext: hasNext ? 'true' : 'false',
+                children: []
+              };
+            }
+          }
+          break;
+        }
+      }
+    }
+  };
+
+  /**
+   * @param {string} id
+   * @param {unknown} comment
+   */
+  const fixCommentInPlace = (id, comment) => {
+    if (!isObject(comment)) {
+      throw new Error('comment is not an object');
+    }
+
+    if (typeof comment.text !== 'string') {
+      throw new Error('comment text is not a string');
+    }
+
+    // Scratch requires comments to not exceed 8000 characters.
+    // We'll store the excess in .extraText so the text won't be truncated if opened in TurboWarp.
+    const MAX_LENGTH = 8000;
+    if (comment.text.length > MAX_LENGTH) {
+      log(`comment ${id} had length ${comment.text.length}`);
+      comment.extraText = comment.text.substring(MAX_LENGTH);
+      comment.text = comment.text.substring(0, MAX_LENGTH);
+    }
+  };
+
+  /**
+   * @param {unknown} target
+   */
+  const fixTargetInPlace = (target) => {
+    const costumes = target.costumes;
+    if (!Array.isArray(costumes)) {
+      throw new Error('costumes is not an array');
+    }
+    for (let i = costumes.length - 1; i >= 0; i--) {
+      const costume = costumes[i];
+      if (!isObject(costume)) {
+        throw new Error(`costume ${i} is not an object`);
+      }
+
+      if (typeof costume.name !== 'string') {
+        log(`costume ${i} name was not a string`);
+        costume.name = String(costume.name);
+      }
+
+      // https://github.com/scratchfoundation/scratch-parser/blob/665f05d739a202d565a4af70a201909393d456b2/lib/sb3_definitions.json#L51
+      const knownCostumeFormats = ['png', 'svg', 'jpeg', 'jpg', 'bmp', 'gif'];
+      if (!knownCostumeFormats.includes(costume.dataFormat)) {
+        if (typeof costume.md5ext === 'string' && costume.md5ext.endsWith('.svg')) {
+          log(`costume ${i} is vector, had invalid dataFormat ${costume.dataFormat}`);
+          costume.dataFormat = 'svg';
+        } else {
+          log(`costume ${i} is bitmap, had invalid dataFormat ${costume.dataFormat}`);
+          // dataFormat is only really used to detect vector or bitmap, so we don't
+          // need to set this to the real format
+          costume.dataFormat = 'png';
+        }
+      }
+
+      if (!('assetId' in costume)) {
+        log(`costume ${i} was missing assetId, deleted`);
+        costumes.splice(i, 1);
+      }
+    }
+    if (costumes.length === 0) {
+      log(`costumes was empty, adding empty costume`);
+      costumes.push({
+        // Empty SVG costume
+        name: 'costume1',
+        bitmapResolution: 1,
+        dataFormat: 'svg',
+        assetId: 'cd21514d0531fdffb22204e0ec5ed84a',
+        md5ext: 'cd21514d0531fdffb22204e0ec5ed84a.svg',
+        rotationCenterX: 0,
+        rotationCenterY: 0
+      });
+    }
+
+    const sounds = target.sounds;
+    if (!Array.isArray(sounds)) {
+      throw new Error('sounds is not an array');
+    }
+    for (let i = sounds.length - 1; i >= 0; i--) {
+      const sound = sounds[i];
+      if (!isObject(sound)) {
+        throw new Error(`sound ${i} is not an object`);
+      }
+
+      // https://github.com/scratchfoundation/scratch-parser/blob/665f05d739a202d565a4af70a201909393d456b2/lib/sb3_definitions.json#L81
+      const knownSoundFormats = ['wav', 'wave', 'mp3'];
+      if (!knownSoundFormats.includes(sound.dataFormat)) {
+        log(`sound ${i} had invalid dataFormat ${sound.dataFormat}`);
+        sound.dataFormat = 'mp3';
+      }
+
+      if (typeof sound.name !== 'string') {
+        log(`sound ${i} name was not a string`);
+        sound.name = String(sound.name);
+      }
+
+      if (!('assetId' in sound)) {
+        log(`sound ${i} was missing assetId, deleted`);
+        sounds.splice(i, 1);
+      }
+    }
+
+    const blocks = target.blocks;
+    if (!isObject(blocks)) {
+      throw new Error('blocks is not an object');
+    }
+    for (const [blockId, block] of Object.entries(blocks)) {
+      if (!fixBlockInPlace(blockId, block)) {
+        // Logging happens in fixBlockInPlace
+        delete blocks[blockId];
+      }
+    }
+
+    if (!platform.nativelyUnderstandsSpork) {
+      fixSporkBackwardsIncompatibilityInPlace(blocks);
+    }
+
+    // Comments are not required
+    const comments = target.comments;
+    if (comments) {
+      for (const [commentId, comment] of Object.entries(comments)) {
+        fixCommentInPlace(commentId, comment);
+      }
+    }
+
+    const variables = target.variables;
+    if (!isObject(variables)) {
+      throw new Error('variables is not an object');
+    }
+    for (const [variableId, variable] of Object.entries(variables)) {
+      fixVariableInPlace(variableId, variable);
+    }
+
+    const lists = target.lists;
+    if (!isObject(lists)) {
+      throw new Error('lists is not an object');
+    }
+    for (const [listId, list] of Object.entries(lists)) {
+      fixListInPlace(listId, list);
+    }
+
+    if (target.isStage) {
+      if (target.layerOrder !== 0) {
+        log('stage had invalid layerOrder');
+        target.layerOrder = 0;
+      }
+    } else {
+      if (target.layerOrder < 1) {
+        log('sprite had invalid layerOrder');
+        target.layerOrder = 1;
+      }
+    }
+
+    const ROTATION_STYLES = [
+      'all around',
+      'don\'t rotate',
+      'left-right'
+    ];
+    if (!target.isStage && !ROTATION_STYLES.includes(target.rotationStyle)) {
+      log(`sprite had invalid rotation style ${target.rotationStyle}`);
+      target.rotationStyle = 'all around';
+    }
+
+    if (!target.isStage) {
+      const x = target.x;
+      if (typeof x !== 'number') {
+        log(`target x was ${typeof x}: ${x}`);
+        target.x = +x || 0;
+      }
+  
+      const y = target.y;
+      if (typeof y !== 'number') {
+        log(`target y was ${typeof y}: ${y}`);
+        target.y = +y || 0;
+      }
+    }
+  };
+
+  /**
+   * @param {unknown} stage
+   */
+  const fixStageInPlace = (stage) => {
+    // stage's name must match exactly
+    if (stage.name !== 'Stage') {
+      log(`stage had wrong name: ${stage.name}`);
+      stage.name = 'Stage';
+    }
+
+    // In vanilla Scratch, "turn video < ... >" with anything that isn't the dropdown allows videoState
+    // to be set to something that isn't one of the expected strings. We'll play it safe and default to
+    // off.
+    const VIDEO_STATES = [
+      'on',
+      'off',
+      'on-flipped'
+    ];
+    if (hasOwn(stage, 'videoState') && !VIDEO_STATES.includes(stage.videoState)) {
+      log(`stage had invalid videoState: ${stage.videoState}`);
+      stage.videoState = 'off';
+    }
+  };
+
+  /**
+   * @param {unknown} project
+   */
+  const fixProjectInPlace = (project) => {
+    if ('objName' in project) {
+      throw new Error('Scratch 2 (sb2) projects not supported');
+    }
+
+    if (!isObject(project)) {
+      throw new Error('Root JSON is not an object');
+    }
+
+    if ('name' in project) {
+      // Not a project. Just a sprite.
+      log('project is a sprite');
+      fixTargetInPlace(project);
+      return;
+    }
+
+    const targets = project.targets;
+    if (!Array.isArray(targets)) {
+      throw new Error('targets is not an array');
+    }
+    if (targets.length < 1) {
+      throw new Error('targets is empty');
+    }
+    for (let i = 0; i < targets.length; i++) {
+      log(`checking target ${i}`);
+      const target = targets[i];
+      if (!isObject(target)) {
+        throw new Error('target is not an object');
+      }
+      fixTargetInPlace(target);
+    }
+
+    const allStages = targets.filter((target) => target.isStage);
+    if (allStages.length === 0) {
+      log('stage is missing; adding an empty one');
+      targets.unshift({
+        isStage: true,
+        name: 'Stage',
+        variables: {},
+        lists: {},
+        broadcasts: {},
+        blocks: {},
+        currentCostume: 0,
+        costumes: [
+          {
+            name: 'backdrop1',
+            dataFormat: 'svg',
+            assetId: 'cd21514d0531fdffb22204e0ec5ed84a',
+            md5ext: 'cd21514d0531fdffb22204e0ec5ed84a.svg',
+            rotationCenterX: 240,
+            rotationCenterY: 180
+          }
+        ],
+        sounds: [],
+        volume: 100,
+        layerOrder: 0,
+        tempo: 60,
+        videoTransparency: 50,
+        videoState: "on",
+        textToSpeechLanguage: null
+      });
+    } else {
+      // We will accept the first stage in targets as the real stage
+      const firstStageIndex = targets.findIndex((target) => target.isStage);
+
+      // Stage must be the first target
+      if (firstStageIndex !== 0) {
+        log(`stage was at wrong index: ${firstStageIndex}`);
+        const stage = targets[firstStageIndex];
+        targets.splice(firstStageIndex, 1);
+        targets.unshift(stage);
+      }
+
+      // Remove all the other stages
+      for (let i = targets.length - 1; i > 0; i--) {
+        if (targets[i].isStage) {
+          log(`removing extra stage at index ${i}`);
+          targets.splice(i, 1);
+        }
+      }
+    }
+
+    // Above checks ensure this invariant holds
+    const stage = targets[0];
+    fixStageInPlace(stage);
+
+    const knownExtensions = getKnownExtensions(project);
+    const monitors = project.monitors;
+    if (!Array.isArray(monitors)) {
+      throw new Error('monitors is not an array');
+    }
+    project.monitors = project.monitors.filter((monitor, i) => {
+      const opcode = monitor.opcode;
+      if (typeof opcode !== 'string') {
+        throw new Error(`monitor ${i} opcode is not a string`);
+      }
+      const extension = opcode.split('_')[0];
+      if (!knownExtensions.has(extension)) {
+        log(`removed monitor ${i} from unknown extension ${extension}`);
+        return false;
+      }
+      return true;
+    });
+  };
+
+  if (typeof data === 'object' && data !== null) {
+    // Already parsed.
+    fixProjectInPlace(data);
+    return data;
+  } else if (typeof data === 'string') {
+    // Need to parse.
+    const parsed = JSON.parse(data);
+    fixProjectInPlace(parsed);
+    return parsed;
+  } else {
+    throw new Error('Unable to tell how to interpret input as JSON');
+  }
+};
+
+/**
+ * @param {ArrayBuffer|Uint8Array|Blob} data A compressed .sb3 file.
+ * @param {Options} [options]
+ * @returns {Promise<Uint8Array>} A promise that resolves to a fixed compressed .sb3 file.
+ */
+const fixZip = async (data, options = {}) => {
+  /**
+   * @param {string} message
+   */
+  const log = (message) => {
+    if (options.logCallback) {
+      options.logCallback(message);
+    }
+  };
+
+  // JSZip is not a small library, so we'll load it somewhat lazily.
+  const JSZip = require('@turbowarp/jszip');
+
+  let zip = await JSZip.loadAsync(data, {
+    recoverCorrupted: true,
+    onCorruptCentralDirectory: (error) => {
+      log(`zip had corrupt central directory: ${error}`);
+    },
+    onUnrecoverableFileEntry: (error) => {
+      log(`zip had unrecoverable file entry: ${error}`);
+    }
+  });
+
+  // Remove any unreadable files from the zip. This can notably happen if the compressed data in the zip was
+  // corrupted, which would make the uncompressed data size field not match. Scratch/JSZip will refuse to
+  // keep loading the project if that happens. If we remove the asset, at least there's a chance it can now
+  // be downloaded from the asset server instead.
+  for (const [relativePath, file] of Object.entries(zip.files)) {
+    if (file.dir) {
+      continue;
+    }
+
+    if (/(?:project|sprite)\.json/.test(relativePath) || /[0-9a-f]{32}\./.test(relativePath)) {
+      try {
+        // If the file is corrupt, this will throw.
+        await file.async('uint8array');
+      } catch (error) {
+        log(`zip had unreadable file ${relativePath}: ${error}`);
+        zip.remove(relativePath);
+      }
+    } else {
+      log(`zip had extraneous file ${relativePath}`);
+      zip.remove(relativePath);
+    }
+  }
+
+  // json is not guaranteed to be stored in the root.
+  const jsonFile = zip.file(/(?:project|sprite)\.json/)[0];
+  if (!jsonFile) {
+    throw new Error('Could not find project.json or sprite.json.');
+  }
+
+  const jsonText = await jsonFile.async('text');
+  const fixedJSON = fixJSON(jsonText, options);
+  const newProjectJSONText = JSON.stringify(fixedJSON);
+  zip.file(jsonFile.name, newProjectJSONText);
+
+  // By default, JSZip will use the current date as the modified timestamp, which would generated zips non-deterministic.
+  const date = new Date('Thu, 14 Mar 2024 00:00:00 GMT');
+  for (const file of Object.values(zip.files)) {
+    file.date = date;
+  }
+
+  const compressed = await zip.generateAsync({
+    type: 'uint8array',
+    compression: 'DEFLATE'
+  });
+  return compressed;
+};
+
+module.exports = {
+  fixJSON,
+  fixZip,
+  platforms
+};