@idosgames/module-sdk 0.3.3 → 0.4.0

package/dist/index.d.cts

@@ -420,6 +420,26 @@ interface EngineScene {
     suspend?(): void;
     /** Optional per-frame tick if the module opts into the host's shared loop. */
     update?(deltaMs: number): void;
+    /**
+     * One still frame of this scene, for the platform's "share a shot of your game" button.
+     *
+     * ⚠ Implement this in the module, do not leave it to the host. A `WebGLRenderer` is created
+     * without `preserveDrawingBuffer` (the default, and the one you want — the flag costs memory and
+     * a copy every frame), which means its drawing buffer is already cleared by the time anyone else
+     * can read the canvas: `canvas.toBlob()` from outside returns a BLACK rectangle, and it does so
+     * silently. The scene is the only place that can render and read in the same turn:
+     *
+     * ```ts
+     * async capture() {
+     *   this.renderer.render(this.scene, this.camera);
+     *   return await new Promise<Blob | null>((r) => this.canvas.toBlob(r, "image/png"));
+     * }
+     * ```
+     *
+     * Resolve `null` when there is nothing meaningful to show (not mounted yet, no renderer). The
+     * host falls back to reading the canvas itself, which is correct for 2D canvases.
+     */
+    capture?(): Promise<Blob | null>;
     /** Permanent teardown — dispose GPU resources, remove listeners. */
     destroy(): void;
 }

package/dist/index.d.ts

@@ -420,6 +420,26 @@ interface EngineScene {
     suspend?(): void;
     /** Optional per-frame tick if the module opts into the host's shared loop. */
     update?(deltaMs: number): void;
+    /**
+     * One still frame of this scene, for the platform's "share a shot of your game" button.
+     *
+     * ⚠ Implement this in the module, do not leave it to the host. A `WebGLRenderer` is created
+     * without `preserveDrawingBuffer` (the default, and the one you want — the flag costs memory and
+     * a copy every frame), which means its drawing buffer is already cleared by the time anyone else
+     * can read the canvas: `canvas.toBlob()` from outside returns a BLACK rectangle, and it does so
+     * silently. The scene is the only place that can render and read in the same turn:
+     *
+     * ```ts
+     * async capture() {
+     *   this.renderer.render(this.scene, this.camera);
+     *   return await new Promise<Blob | null>((r) => this.canvas.toBlob(r, "image/png"));
+     * }
+     * ```
+     *
+     * Resolve `null` when there is nothing meaningful to show (not mounted yet, no renderer). The
+     * host falls back to reading the canvas itself, which is correct for 2D canvases.
+     */
+    capture?(): Promise<Blob | null>;
     /** Permanent teardown — dispose GPU resources, remove listeners. */
     destroy(): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@idosgames/module-sdk",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "description": "The composable-module contract for the iDosGames host shell: Module / ModuleContext types plus tiny authoring helpers. Framework-neutral at runtime — a module can be a game (Three/Phaser), a plain app, or an AI app.",
   "type": "module",
   "license": "MIT",
@@ -46,7 +46,7 @@
   },
   "//": "@idosgames/core is a real range, not '*': a published contract must name the version of core whose IDosGamesClient/SdkEvents shapes it references. Bump in step with core (see RELEASING.md). react is an OPTIONAL peer — the contract references React's ComponentType type only (a UI panel is a React component), which is erased at build, so a runtime-only module needs no React.",
   "dependencies": {
-    "@idosgames/core": "^0.16.0"
+    "@idosgames/core": "^0.17.0"
   },
   "peerDependencies": {
     "react": "^18.3.1 || ^19.0.0"