@turbowarp/types 0.0.3 → 0.0.4

package/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Contributing
+
+Our goal is to document all the APIs exposed by Scratch. We accept any contributions that work towards that goal.
+
+Even if you aren't able to write types, please open issues to report missing or incorrect types.
+
+In terms of code style, we aren't super picky. Just keep it consistent with whatever is already there.
+
+For very complex types, please add a small test case in the `tests` directory. Presumably you already wrote some test code while writing the types, so just don't delete that once you're done.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turbowarp/types",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Type definitions for the Scratch VM and editor",
   "keywords": [
     "scratch"

package/types/paper.d.ts

@@ -9,4 +9,9 @@ declare namespace Paper {
   interface Matrix {
     // TODO
   }
+
+  interface Tool {
+    // TODO
+    activate(): void;
+  }
 }

package/types/scratch-gui.d.ts

@@ -452,73 +452,73 @@ declare namespace ScratchGUI {
     {
       type: 'scratch-gui/project-state/DONE_CREATING_COPY';
       projectId: string;
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/DONE_CREATING_NEW';
       projectId: string;
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/DONE_FETCHING_DEFAULT';
       projectData: ProjectData;
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/DONE_FETCHING_WITH_ID';
       projectData: ProjectData;
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/DONE_LOADING_VM_TO_SAVE';
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/DONE_LOADING_VM_WITH_ID';
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/DONE_LOADING_VM_WITHOUT_ID';
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/DONE_REMIXING';
       projectId: string;
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/DONE_UPDATING';
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/DONE_UPDATING_BEFORE_COPY';
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/DONE_UPDATING_BEFORE_NEW';
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/RETURN_TO_SHOWING';
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/SET_PROJECT_ID';
       projectId: string;
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/START_AUTO_UPDATING';
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/START_CREATING_NEW';
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/START_ERROR';
       error: unknown;
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/START_FETCHING_NEW';
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/START_LOADING_VM_FILE_UPLOAD';
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/START_MANUAL_UPDATING';
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/START_REMIXING';
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/START_UPDATING_BEFORE_CREATING_COPY';
-    } | 
+    } |
     {
       type: 'scratch-gui/project-state/START_UPDATING_BEFORE_CREATING_NEW';
     } |

package/types/scratch-paint.ts

@@ -171,7 +171,7 @@ declare namespace ScratchPaint {
     {
       type: 'scratch-paint/eye-dropper/ACTIVATE_COLOR_PICKER';
       callback: ScratchPaintState['color']['eyeDropper']['callback'];
-      previousMode: Mode;
+      previousMode: Paper.Tool;
     } |
     {
       type: 'scratch-paint/eye-dropper/DEACTIVATE_COLOR_PICKER';

package/types/scratch-vm.d.ts

@@ -76,6 +76,8 @@ declare namespace VM {
     name: string;
     costumes: Costume[];
     sounds: Sound[];
+    clones: RenderedTarget[];
+    soundBank: AudioEngine.SoundBank | null;
   }
 
   interface Field {
@@ -297,6 +299,8 @@ declare namespace VM {
 
     comments: Record<string, Comment>;
 
+    createComment(id: string, blockId: string, text: string, x: number, y: number, width: number, height: number, minimized?: boolean): void;
+
     /**
      * Called by runtime when the green flag is pressed.
      */
@@ -990,6 +994,11 @@ declare namespace VM {
      */
     start(): void;
 
+    /**
+     * Stop all timers.
+     */
+    quit(): void;
+
     /**
      * Start "when green flag pressed" scripts.
      */
@@ -1297,6 +1306,11 @@ declare class VM extends EventEmitter<VM.VirtualMachineEventMap> {
    */
   start(): void;
 
+  /**
+   * @see {VM.Runtime.quit}
+   */
+  quit(): void;
+
   /**
    * @see {VM.Runtime.greenFlag}
    */