@turbowarp/types 0.0.2 → 0.0.4

package/.github/workflows/validate.yml

@@ -20,5 +20,10 @@ jobs:
         run: npm ci
       - name: Validate TypeScript
         run: npm test
-      - name: Validate index.d.ts
-        run: npx tsc index.d.ts
+      - name: Validate individual .d.ts files
+        run: |
+          set -e
+          for i in index.d.ts types/*.d.ts; do
+            echo "Validating $i"
+            npx tsc "$i" --target es6 --noEmit
+          done

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/README.md

@@ -1,4 +1,4 @@
-# Types definitions for the Scratch VM and editor
+# Type definitions for the Scratch VM and editor
 
 Scratch doesn't provide type definitions for their libraries, so we wrote our own.
 
@@ -10,14 +10,14 @@ Despite being in the TurboWarp organization, this project is currently focused o
 |:-:|:-:|
 |scratch-vm|✅|
 |scratch-render|✅|
-|scratch-svg-renderer|❌|
-|scratch-render-fonts|❌|
-|scratch-audio|🚧|
-|scratch-storage|❌|
-|scratch-parser|❌|
+|scratch-svg-renderer|✅|
+|scratch-render-fonts|✅|
+|scratch-audio|✅|
+|scratch-storage|✅|
+|scratch-parser|✅|
 |scratch-blocks|🚧|
-|scratch-gui redux|❌|
-|scratch-paint redux|❌|
+|scratch-gui redux|✅|
+|scratch-paint redux|✅|
 |scratch-www redux|❌|
 
 ## Using from npm

package/package.json

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

package/tests/scratch-audio.ts

@@ -0,0 +1,17 @@
+import AudioEngine from 'scratch-audio';
+
+declare const vm: VM;
+const audioEngine = new AudioEngine();
+vm.attachAudioEngine(audioEngine);
+
+audioEngine.decodeSoundPlayer({
+  data: {
+    buffer: new ArrayBuffer(10)
+  }
+})
+  .then((player) => {
+    player.on('stop', () => {
+
+    });
+    return player.finished();
+  });

package/tests/scratch-gui.ts

@@ -0,0 +1,16 @@
+declare const state: ScratchGUI.ReduxState;
+declare function dispatch(event: ScratchGUI.ReduxEvent): void;
+
+const vm = state.scratchGui.vm;
+vm.greenFlag();
+vm.renderer._allDrawables[0].updateVisible(false);
+
+dispatch({
+  type: 'scratch-gui/navigation/ACTIVATE_TAB',
+  activeTabIndex: 0
+});
+
+state.scratchPaint.cursor.charAt(0);
+dispatch({
+  type: 'scratch-paint/undo/CLEAR'
+});

package/tests/scratch-parser.ts

@@ -0,0 +1,9 @@
+import unpack from 'scratch-parser';
+
+unpack('{}', false, (error, unpacked) => {
+  if (error) {
+    console.error(error);
+  } else {
+    const [target, zip] = unpacked;
+  }
+});

package/tests/scratch-render-fonts.ts

@@ -0,0 +1,4 @@
+import getFonts from 'scratch-render-fonts';
+
+const fonts = getFonts();
+console.log(atob(fonts['Curly']));

package/tests/scratch-storage.ts

@@ -0,0 +1,22 @@
+import ScratchStorage from 'scratch-storage';
+
+declare const vm: VM;
+
+const storage = new ScratchStorage();
+vm.attachStorage(storage);
+
+ScratchStorage.DataFormat.JPG === 'jpg';
+storage.DataFormat.JPG === 'jpg';
+
+storage.addWebStore(
+  [
+    ScratchStorage.AssetType.ImageVector,
+    ScratchStorage.AssetType.ImageBitmap,
+    storage.AssetType.Sound,
+  ],
+  asset => {
+    const assetId = asset.assetId;
+    const dataFormat = asset.dataFormat;
+    return `https://assets.scratch.mit.edu/${assetId}.${dataFormat}`;
+  }
+);

package/tests/scratch-svg-renderer.ts

@@ -0,0 +1,8 @@
+import * as SvgRenderer from 'scratch-svg-renderer';
+
+const svg = SvgRenderer.loadSvgString('imagine that this is an SVG', false);
+const serialized = SvgRenderer.serializeSvgToString(svg);
+const inlinedFonts = SvgRenderer.inlineSvgFonts('an svg here');
+const fixedFonts = SvgRenderer.convertFonts(SvgRenderer.SvgElement.create('svg'));
+
+const bitmapAdapter = new SvgRenderer.BitmapAdapter();

package/tests/vm.ts

@@ -40,6 +40,12 @@ if (target) {
     const mutation = block.mutation as VM.ProcedureCallMutation;
     JSON.parse(mutation.argumentids);
   }
+
+  const bubbleState = target.getCustomState('Scratch.looks');
+  if (bubbleState) {
+    bubbleState.text.charAt(0);
+    target.setCustomState('Scratch.looks', bubbleState);
+  }
 } else {
   const doesNotExist: undefined = target;
 }

package/types/paper.d.ts

@@ -0,0 +1,17 @@
+// Type definitions for paper.js
+// Project: https://github.com/LLK/paper.js
+
+declare namespace Paper {
+  interface Base {
+    // TODO
+  }
+
+  interface Matrix {
+    // TODO
+  }
+
+  interface Tool {
+    // TODO
+    activate(): void;
+  }
+}

package/types/react.d.ts

@@ -0,0 +1,8 @@
+// Type definitions for React 16
+// Project: https://reactjs.org/
+
+declare namespace React {
+  interface Element {
+    // TODO
+  }
+}

package/types/scratch-audio.d.ts

@@ -1,8 +1,74 @@
 // Type definitions for scratch-audio
 // Project: https://github.com/LLK/scratch-audio
 
+/// <reference path="./events.d.ts" />
+
 declare namespace AudioEngine {
-  interface SoundPlayer {
+  interface Target {
+    // TODO
+  }
+
+  interface Loudness {
+    audioContext: AudioContext;
+    connectingToMic: boolean;
+    mic: MediaStreamAudioSourceNode;
+
+    /**
+     * @returns Loudness measured from 0-100.
+     */
+    getLoudness(): number;
+  }
+
+  interface Effect {
+    audioEngine: AudioEngine;
+    audioPlayer: SoundPlayer;
+    lastEffect: Effect;
+    value: number;
+    initialized: boolean;
+    initialize(): void;
+    inputNode: AudioNode;
+    getInputNode(): AudioNode;
+    outputNode: AudioNode;
+    target: Target;
+    connect(target: Target): void;
+    get name(): string;
+    get DEFAULT_VALUE(): string;
+    get _isPatch(): boolean;
+    _set(value: number): void;
+    set(value: number): void;
+    update(): void;
+    clear(): void;
+    dispose(): void;
+  }
+
+  interface EffectChain {
+    audioEngine: AudioEngine;
+    inputNode: GainNode;
+    getInputNode(): GainNode;
+    effects: Effect[];
+    _effects: Effect[];
+    firstEffect: Effect;
+    lastEffect: Effect;
+    _soundPlayers: Set<SoundPlayer>;
+    getSoundPlayers(): SoundPlayer[];
+    clone(): EffectChain;
+    addSoundPlayer(soundPlayer: SoundPlayer): void;
+    removeSoundPlayer(soundPlayer: SoundPlayer): void;
+    target?: AudioNode;
+    connect(target: AudioNode): void;
+    setEffectsFromTarget(target: Target): void;
+    set(effect: string, value: number): void;
+    update(): void;
+    clear(): void;
+    dispose(): void;
+  }
+
+  interface SoundPlayerEventMap {
+    stop: [];
+    play: [];
+  }
+
+  interface SoundPlayer extends EventEmitter<SoundPlayerEventMap> {
     id: string;
     audioEngine: AudioEngine;
     buffer: AudioBuffer;
@@ -21,9 +87,64 @@ declare namespace AudioEngine {
     finished(): Promise<void>;
     setPlaybackRate(playbackRate: number): void;
   }
+
+  interface SoundBank {
+    audioEngine: AudioEngine;
+    soundPlayers: Record<string, SoundPlayer>;
+    playerTargets: Record<string, Target>;
+    soundEffects: Record<string, EffectChain>;
+    effectChainPrime: EffectChain;
+    addSoundPlayer(soundPlayer: SoundPlayer): void;
+    getSoundPlayer(soundId: string): SoundPlayer | undefined;
+    getSoundEffects(soundId: string): EffectChain;
+    playSound(target: Target, soundId: string): Promise<void>;
+    setEffects(target: Target): void;
+    stop(target: Target, soundId: string): void;
+    stopAllSounds(target: Target | '*'): void;
+    dispose(): void;
+  }
+
+  interface SoundToDecode {
+    data: {
+      buffer: ArrayBuffer;
+    }
+  }
 }
 
 declare class AudioEngine {
+  constructor(audioContext?: AudioContext);
+
   audioContext: AudioContext;
+  get currentTime(): number;
+
   inputNode: GainNode;
+  getInputNode(): GainNode;
+
+  audioBuffers: Record<string, ArrayBuffer>;
+
+  loudness: AudioEngine.Loudness | null;
+  /**
+   * @see {AudioEngine.Loudness.getLoudness}
+   */
+  getLoudness(): number;
+
+  effects: AudioEngine.Effect[];
+  get EFFECT_NAMES(): Record<string, string>;
+  get DECAY_DURATION(): number;
+  get DECAY_WAIT(): number;
+
+  _emptySound(): AudioBuffer;
+
+  decodeSound(sound: AudioEngine.SoundToDecode): Promise<string>;
+
+  decodeSoundPlayer(sound: AudioEngine.SoundToDecode): Promise<AudioEngine.SoundPlayer>;
+
+  /**
+   * Returns a tuple of [sound id, buffer]
+   */
+  _decodeSound(sound: AudioEngine.SoundToDecode): Promise<[string, AudioBuffer]>;
+
+  createEffectChain(): AudioEngine.EffectChain;
+
+  createBank(): AudioEngine.SoundBank;
 }