@turbowarp/types 0.0.13 → 0.0.14

package/.github/workflows/deploy.yml

@@ -1,4 +1,4 @@
-name: Deploy playground
+name: Deploy documentation to GitHub Pages
 
 on:
   workflow_dispatch:
@@ -13,20 +13,19 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+      - uses: actions/checkout@v6
         with:
           persist-credentials: false
       - name: Install Node.js
-        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af
+        uses: actions/setup-node@v6
         with:
-          node-version: 20
-          cache: npm
+          node-version: 24
       - name: Install dependencies
         run: npm ci
       - name: Build documentation
         run: npm run build
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa
+        uses: actions/upload-pages-artifact@v4
         with:
           path: ./docs/
 
@@ -42,4 +41,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e
+        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

@@ -9,14 +9,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+      - uses: actions/checkout@v6
         with:
           persist-credentials: false
       - name: Setup Node.js
-        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af
+        uses: actions/setup-node@v6
         with:
-          node-version: 20
-          cache: npm
+          node-version: 24
       - name: Install dependencies
         run: npm ci
       - name: Validate TypeScript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turbowarp/types",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "Type definitions for the Scratch VM and editor",
   "keywords": [
     "scratch"
@@ -26,7 +26,7 @@
   },
   "homepage": "https://github.com/TurboWarp/types#readme",
   "devDependencies": {
-    "typedoc": "^0.25.12",
-    "typescript": "^4.7.4"
+    "typedoc": "^0.28.15",
+    "typescript": "^5.9.3"
   }
 }

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;
 
@@ -740,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 {
@@ -1181,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.
@@ -1199,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;