@turbowarp/types 0.0.11 → 0.0.13

package/.github/workflows/deploy.yml

@@ -0,0 +1,45 @@
+name: Deploy playground
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [master]
+
+concurrency:
+  group: "deploy"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+        with:
+          persist-credentials: false
+      - name: Install Node.js
+        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af
+        with:
+          node-version: 20
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Build documentation
+        run: npm run build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa
+        with:
+          path: ./docs/
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e

package/.github/workflows/validate.yml

@@ -2,28 +2,25 @@ name: Validate TypeScript
 
 on:
   push:
-    branches: [ "master" ]
   pull_request:
-    branches: [ "master" ]
 
 jobs:
   test:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
-      - name: Setup Node.js environment
-        uses: actions/setup-node@v3.4.1
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
         with:
-          node-version: 14.x
+          persist-credentials: false
+      - name: Setup Node.js
+        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af
+        with:
+          node-version: 20
+          cache: npm
       - name: Install dependencies
         run: npm ci
       - name: Validate TypeScript
         run: npm test
       - 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
+          parallel -v npx tsc --target es6 --noEmit ::: index.d.ts types/*.d.ts

package/README.md

@@ -4,6 +4,8 @@ Scratch doesn't provide type definitions for their libraries, so we wrote our ow
 
 This repository only contains types for the vanilla (LLK) Scratch runtime and editor. For the additional types in the TurboWarp runtimes, see [@turbowarp/types-tw](https://github.com/TurboWarp/types-tw).
 
+A possibly more human-readable version of the TypeScript definitions can be found at: https://turbowarp.github.io/types/
+
 |Module|Status|
 |:-:|:-:|
 |scratch-vm|✅|

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turbowarp/types",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "Type definitions for the Scratch VM and editor",
   "keywords": [
     "scratch"
@@ -12,7 +12,8 @@
   },
   "scripts": {
     "test": "tsc",
-    "watch": "tsc -w"
+    "watch": "tsc -w",
+    "build": "typedoc types/*"
   },
   "repository": {
     "type": "git",
@@ -24,8 +25,8 @@
     "url": "https://github.com/TurboWarp/types/issues"
   },
   "homepage": "https://github.com/TurboWarp/types#readme",
-  "dependencies": {},
   "devDependencies": {
+    "typedoc": "^0.25.12",
     "typescript": "^4.7.4"
   }
 }

package/tests/test-scratch-storage.ts

@@ -20,3 +20,18 @@ storage.addWebStore(
     return `https://assets.scratch.mit.edu/${assetId}.${dataFormat}`;
   }
 );
+
+storage.createAsset(
+  storage.AssetType.ImageBitmap,
+  storage.DataFormat.PNG,
+  new Uint8Array([]),
+  null,
+  true
+) as ScratchStorage.Asset;
+storage.createAsset(
+  storage.AssetType.ImageBitmap,
+  storage.DataFormat.PNG,
+  new Uint8Array([]),
+  "1234567",
+  false
+) as ScratchStorage.Asset;

package/types/scratch-render.d.ts

@@ -604,8 +604,8 @@ declare class RenderWebGL extends EventEmitter<RenderWebGL.ScratchRenderEventMap
   updateDrawableSkinId(drawableId: number, skinId: number): void;
   updateDrawablePosition(drawableId: number, position: [number, number]): void;
   updateDrawableDirection(drawableId: number, direction: number): void;
-  updateDrawableScale(drawableId: number, scale: number): void;
-  updateDrawableDirectionScale(drawableId: number, direction: number, scale: number): void;
+  updateDrawableScale(drawableId: number, scale: [number, number]): void;
+  updateDrawableDirectionScale(drawableId: number, direction: number, scale: [number, number]): void;
   updateDrawableVisible(drawableId: number, visible: boolean): void;
   updateDrawableEffect(drawableId: number, effectName: RenderWebGL.Effect, value: number): void;
   /**

package/types/scratch-storage.d.ts

@@ -78,7 +78,8 @@ declare class ScratchStorage {
 
   store(assetType: ScratchStorage.Asset, dataFormat: ScratchStorage.DataFormat, data: ArrayBuffer, assetId: string): Promise<unknown>;
 
-  createAsset(assetType: ScratchStorage.AssetType, dataFormat: ScratchStorage.DataFormat, data: ArrayBuffer, assetId: string, generateId?: boolean): void;
+  createAsset(assetType: ScratchStorage.AssetType, dataFormat: ScratchStorage.DataFormat, data: ArrayBuffer, assetId: null, generateId: true): ScratchStorage.Asset;
+  createAsset(assetType: ScratchStorage.AssetType, dataFormat: ScratchStorage.DataFormat, data: ArrayBuffer, assetId: string, generateId?: boolean): ScratchStorage.Asset;
 
   addWebStore(types: ScratchStorage.AssetType[], getFunction: ScratchStorage.UrlFunction, createFunction?: ScratchStorage.UrlFunction, updateFunction?: ScratchStorage.UrlFunction): void;
 

package/types/scratch-vm.d.ts

@@ -180,6 +180,12 @@ declare namespace VM {
     forceNoGlow: boolean;
   }
 
+  interface RuntimeScriptCache {
+    container: Blocks;
+    blockId: string;
+    fieldsOfInputs: Record<string, Field>;
+  }
+
   interface BaseVariable {
     id: string;
     name: string;
@@ -601,6 +607,8 @@ declare namespace VM {
      */
     onStopAll(): void;
 
+    updateAllDrawableProperties(): void;
+
     toJSON(): SerializedTarget;
   }
 
@@ -772,7 +780,7 @@ declare namespace VM {
     /**
      * Load a remote extension. Does not work on scratch.mit.edu.
      */
-    loadExtensionURL(extensionID: string): void;
+    loadExtensionURL(extensionID: string): Promise<number>;
   }
 
   /**
@@ -907,7 +915,7 @@ declare namespace VM {
   interface UserData {
     _username: string;
     getUsername(): string;
-    postData(data: UserData): void;
+    postData(data: UserDataData): void;
   }
 
   interface VideoProvider {
@@ -1200,7 +1208,7 @@ declare namespace VM {
 
     allScriptsDo(callback: (blockId: string, target: Target) => void, target?: Target): void;
 
-    allScriptsByOpcodeDo(opcode: string, callback: (blockId: string, target: Target) => void, target?: Target): void;
+    allScriptsByOpcodeDo(opcode: string, callback: (script: RuntimeScriptCache, target: Target) => void, target?: Target): void;
 
     sequencer: Sequencer;