@turbowarp/types 0.0.8 → 0.0.10

package/package.json

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

package/tests/test-scratch-vm-extension.js

@@ -19,6 +19,7 @@
               }
             }
           },
+          '---',
           {
             opcode: 'test',
             text: 'test [STRING] [IMAGE] [BOOLEAN] [NUMBER] [MATRIX] [NOTE] [ANGLE] [COLOR]',
@@ -61,7 +62,6 @@
             }
           },
           {
-            opcode: 'button',
             blockType: Scratch.BlockType.BUTTON,
             func: 'MAKE_A_VARIABLE',
             text: 'button text'

package/tests/test-scratch-vm.ts

@@ -21,7 +21,7 @@ if (target) {
   const variable = target.lookupVariableByNameAndType('test', 'list');
   if (variable) {
     const name: string = variable.name;
-    const upToDate: boolean | undefined = variable.value._monitorUpToDate;
+    const upToDate: boolean | undefined = variable._monitorUpToDate;
     variable.value.filter(i => i.toString());
   }
 
@@ -64,6 +64,9 @@ if (target) {
   const doesNotExist: undefined = target;
 }
 
+runtime._editingTarget as VM.Target;
+runtime.getEditingTarget() as VM.Target;
+
 const audioEngine = new AudioEngine();
 vm.attachAudioEngine(audioEngine);
 audioEngine.audioContext.suspend();

package/types/scratch-vm-extension.d.ts

@@ -14,12 +14,10 @@ declare namespace Scratch {
 
   namespace BlockType {
     const BOOLEAN: 'Boolean';
-    /** @deprecated very incomplete and not useful yet */
     const BUTTON: 'button';
     const COMMAND: 'command';
     /** @deprecated does not work in compiler */
     const CONDITIONAL: 'conditional';
-    /** @deprecated use HAT instead */
     const EVENT: 'event';
     const HAT: 'hat';
     /** @deprecated does not work in compiler */
@@ -101,29 +99,31 @@ declare namespace Scratch {
   );
 
   interface AbstractBlock {
+    text: string | string[];
+    filter?: Array<'target' | 'sprite'>;
+  }
+  interface ExecutableBlock extends AbstractBlock {
     opcode: string;
     func?: string;
-    text: string | string[];
     arguments?: Record<string, Argument>;
     hideFromPalette?: boolean;
-    filter?: Array<'target' | 'sprite'>;
     blockIconURI?: string;
   }
-  interface BooleanBlock extends AbstractBlock {
+  interface BooleanBlock extends ExecutableBlock {
     blockType: 'Boolean';
   }
   interface ButtonBlock extends AbstractBlock {
     blockType: 'button';
     func: 'MAKE_A_LIST' | 'MAKE_A_PROCEDURE' | 'MAKE_A_VARIABLE';
   }
-  interface CommandBlock extends AbstractBlock {
+  interface CommandBlock extends ExecutableBlock {
     blockType: 'command';
     /**
      * Defaults to false.
      */
     isTerminal?: boolean;
   }
-  interface ConditionalBlock extends AbstractBlock {
+  interface ConditionalBlock extends ExecutableBlock {
     blockType: 'conditional';
     /**
      * Defaults to false.
@@ -134,7 +134,7 @@ declare namespace Scratch {
      */
     branchCount?: number;
   }
-  interface EventBlock extends AbstractBlock {
+  interface EventBlock extends ExecutableBlock {
     blockType: 'event';
     /**
      * This must be explicitly set to false, otherwise the block will not work.
@@ -146,7 +146,7 @@ declare namespace Scratch {
      */
     shouldRestartExistingThreads?: boolean;
   }
-  interface HatBlock extends AbstractBlock {
+  interface HatBlock extends ExecutableBlock {
     blockType: 'hat';
     /**
      * Defaults to true.
@@ -157,14 +157,14 @@ declare namespace Scratch {
      */
     shouldRestartExistingThreads?: boolean;
   }
-  interface ReporterBlock extends AbstractBlock {
+  interface ReporterBlock extends ExecutableBlock {
     blockType: 'reporter';
     /**
      * Defaults to false.
      */
     disableMonitor?: boolean;
   }
-  interface LoopBlock extends AbstractBlock {
+  interface LoopBlock extends ExecutableBlock {
     blockType: 'loop';
     /**
      * Defaults to false.
@@ -186,6 +186,8 @@ declare namespace Scratch {
     LoopBlock
   );
 
+  type Separator = '---';
+
   interface Menu {
     acceptReporters?: boolean;
     /**
@@ -232,7 +234,7 @@ declare namespace Scratch {
 
     docsURI?: string;
 
-    blocks: (Block | string)[];
+    blocks: (Block | Separator)[];
     menus?: Record<string, Menu | string[]>;
   }
 

package/types/scratch-vm.d.ts

@@ -31,11 +31,7 @@ declare namespace VM {
   type IfGui<HasGui, NoGui> = HasGui;
 
   type ScratchCompatibleValue = string | boolean | number;
-
-  interface ScratchList extends Array<ScratchCompatibleValue> {
-    _monitorUpToDate?: boolean;
-  }
-
+  type ScratchList = ScratchCompatibleValue[];
   type VariableValue = ScratchCompatibleValue | ScratchList;
 
   interface BaseAsset {
@@ -205,6 +201,7 @@ declare namespace VM {
   interface ListVariable extends BaseVariable {
     type: 'list';
     value: ScratchList;
+    _monitorUpToDate?: boolean;
   }
 
   interface BroadcastVariable extends BaseVariable {
@@ -762,6 +759,8 @@ declare namespace VM {
   interface ExtensionManager {
     runtime: Runtime;
 
+    refreshBlocks(): Promise<void[]>;
+
     isExtensionLoaded(extensionID: string): boolean;
 
     /**
@@ -1144,7 +1143,7 @@ declare namespace VM {
     getTargetById(targetId: string): Target | undefined;
 
     /**
-     * Find a sprite's original target (not a clone) using the sprite's name.
+     * Find a sprite's original target (not a clone or stage) using the sprite's name.
      * Returns undefined if the target doesn't exist.
      */
     getSpriteTargetByName(spriteName: string): Target | undefined;
@@ -1313,6 +1312,7 @@ declare namespace VM {
 
     emitProjectChanged(): void;
 
+    _editingTarget: Target | null;
     getEditingTarget(): Target | null;
 
     setEditingTarget(target: Target): void;