@turbowarp/types 0.0.12 → 0.0.14

package/.github/workflows/deploy.yml

@@ -0,0 +1,44 @@
+name: Deploy documentation to GitHub Pages
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [master]
+
+concurrency:
+  group: "deploy"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+      - name: Install Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+      - name: Install dependencies
+        run: npm ci
+      - name: Build documentation
+        run: npm run build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        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@v4

package/.github/workflows/publish.yml

@@ -0,0 +1,22 @@
+name: Publish to npm
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 24
+      - run: npm ci
+      - run: npm test
+      - run: npm publish

package/.github/workflows/validate.yml

@@ -2,28 +2,24 @@ 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@v6
         with:
-          node-version: 14.x
+          persist-credentials: false
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
       - 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.12",
+  "version": "0.0.14",
   "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": {
-    "typescript": "^4.7.4"
+    "typedoc": "^0.28.15",
+    "typescript": "^5.9.3"
   }
 }

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

@@ -28,7 +28,7 @@ declare namespace ScratchStorage {
   }
 
   class Asset {
-    constructor(assetType: AssetType, assetId: string, dataFormat: DataFormat | null, data: ArrayBuffer, generateId?: boolean);
+    constructor(assetType: AssetType, assetId: string, dataFormat: DataFormat | null, data: Uint8Array, generateId?: boolean);
 
     assetType: AssetType;
 
@@ -39,7 +39,7 @@ declare namespace ScratchStorage {
      */
     assetId: string;
 
-    setData(data: ArrayBuffer, dataFormat: DataFormat, generateId?: boolean): void;
+    setData(data: Uint8Array, dataFormat: DataFormat, generateId?: boolean): void;
     encodeTextData(text: string, dataFormat: DataFormat, generateId?: boolean): void;
 
     decodeText(): string;
@@ -55,7 +55,7 @@ declare namespace ScratchStorage {
 
   interface Helper {
     load(assetType: AssetType, assetId: string, dataFormat: DataFormat): Promise<Asset>;
-    store(assetType: AssetType, dataFormat: DataFormat, data: ArrayBuffer, assetId: string): Promise<unknown>;
+    store(assetType: AssetType, dataFormat: DataFormat, data: Uint8Array, assetId: string): Promise<unknown>;
   }
 }
 
@@ -72,14 +72,14 @@ declare class ScratchStorage {
    */
   get(assetId: string): ScratchStorage.Asset | null;
 
-  cache(assetType: ScratchStorage.AssetType, dataFormat: ScratchStorage.DataFormat, data: ArrayBuffer, assetId: string): string;
+  cache(assetType: ScratchStorage.AssetType, dataFormat: ScratchStorage.DataFormat, data: Uint8Array, assetId: string): string;
 
   load(assetType: ScratchStorage.AssetType, assetId: string, dataFormat: ScratchStorage.DataFormat): Promise<ScratchStorage.Asset | null>;
 
-  store(assetType: ScratchStorage.Asset, dataFormat: ScratchStorage.DataFormat, data: ArrayBuffer, assetId: string): Promise<unknown>;
+  store(assetType: ScratchStorage.Asset, dataFormat: ScratchStorage.DataFormat, data: Uint8Array, assetId: string): Promise<unknown>;
 
-  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;
+  createAsset(assetType: ScratchStorage.AssetType, dataFormat: ScratchStorage.DataFormat, data: Uint8Array, assetId: null, generateId: true): ScratchStorage.Asset;
+  createAsset(assetType: ScratchStorage.AssetType, dataFormat: ScratchStorage.DataFormat, data: Uint8Array, 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

@@ -41,9 +41,9 @@ declare namespace VM {
     assetId: string;
 
     /**
-     * The md5 + file extension of this asset.
+     * The md5 + file extension of this asset. May be missing.
      */
-    md5: string;
+    md5?: string;
 
     name: string;
 
@@ -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;
@@ -734,12 +740,33 @@ declare namespace VM {
     // TODO
   }
 
-  interface Profiler {
-    // TODO
+  interface ProfilerFrame {
+    id: number;
+    totalTime: number;
+    selfTime: number;
+    arg: unknown;
+    depth: number;
+    count: number;
   }
 
-  interface ProfilerFrame {
-    // TODO
+  type FrameCallback = (frame: ProfilerFrame) => void;
+
+  interface Profiler {
+    records: unknown[];
+    increments: ProfilerFrame[];
+    counters: ProfilerFrame[];
+    nullFrame: ProfilerFrame;
+    _stack: ProfilerFrame[];
+    onFrame: FrameCallback;
+    START: 0;
+    STOP: 1;
+    start(id: number, arg: unknown): void;
+    stop(): void;
+    increment(id: number): void;
+    frame(id: string, arg: unknown): ProfilerFrame;
+    reportFrames(): void;
+    idByName(name: string): number;
+    nameById(id: number): string;
   }
 
   interface Sequencer {
@@ -909,7 +936,7 @@ declare namespace VM {
   interface UserData {
     _username: string;
     getUsername(): string;
-    postData(data: UserData): void;
+    postData(data: UserDataData): void;
   }
 
   interface VideoProvider {
@@ -1175,7 +1202,7 @@ declare namespace VM {
 
     _stopThread(thread: Thread): void;
 
-    _restartThread(thread: Thread): void;
+    _restartThread(thread: Thread): Thread;
 
     /**
      * A thread is considered active if it is in the thread list and is not STATUS_DONE.
@@ -1193,7 +1220,7 @@ declare namespace VM {
 
     _getMonitorThreadCount(threads: Thread[]): number;
 
-    startHats(opcode: string, matchFields?: Record<string, unknown>, target?: Target): Thread[];
+    startHats(opcode: string, matchFields?: Record<string, unknown>, target?: Target): Thread[] | undefined;
 
     toggleScript(topBlockId: string, options?: {
       target?: string;
@@ -1202,7 +1229,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;