@yodaos-pkg/ink 0.7.0 → 0.8.0

package/README.md

@@ -397,6 +397,38 @@ Starts the continuous render loop.
 - `InkView`
   - Returns the current instance so it can be chained
 
+### `view.setOnCloseRequested(callback)`
+
+Registers a host callback for runtime-driven close requests.
+
+**Parameters**
+
+- `callback: (() => void) | null`
+  - Required
+  - Called after Ink emits `lifecycle.closeRequested`
+  - Pass `null` to clear the callback
+
+**What it does**
+
+- Listens for close requests emitted by the Ink runtime
+- Automatically calls `stopRendering()` before invoking the callback
+- Lets the host destroy or replace the closed view on its own timing
+
+**Returns**
+
+- `InkView`
+  - Returns the current instance so it can be chained
+
+### `view.isCloseRequested()`
+
+Returns whether Ink has already requested that the host close this view.
+
+**Returns**
+
+- `boolean`
+  - `true` after the runtime emits `lifecycle.closeRequested`
+  - `false` before any close request, or after the host opens a new app in the same view
+
 ### `view.destroy()`
 
 Destroys the current `InkView` and releases its resources.
@@ -411,6 +443,7 @@ Destroys the current `InkView` and releases its resources.
 - Removes event listeners created by `bindDomEvents()`
 - Calls the underlying `InkWebView.destroy()`
 - Releases runtime resources held by the current view
+- Should be called by the host after a close-requested view is no longer needed
 
 **Returns**
 
@@ -590,6 +623,11 @@ const view = await createInkView({
 });
 
 view.bindDomEvents();
+view.setOnCloseRequested(() => {
+  if (view.isCloseRequested()) {
+    view.destroy();
+  }
+});
 view.openBundle({
   appId: 'demo-app',
   files,
@@ -632,6 +670,11 @@ const view = await createInkView({
 
 ```js
 view.bindDomEvents();
+view.setOnCloseRequested(() => {
+  if (view.isCloseRequested()) {
+    view.destroy();
+  }
+});
 
 await view.openFromVfs({
   appId: 'demo-app',
@@ -703,6 +746,11 @@ onMounted(async () => {
   });
 
   view.bindDomEvents();
+  view.setOnCloseRequested(() => {
+    if (view.isCloseRequested()) {
+      view.destroy();
+    }
+  });
   view.openBundle({
     appId: props.appId,
     files: props.files,
@@ -788,6 +836,11 @@ export function InkCanvas({ appId, files }: InkCanvasProps) {
       });
 
       view.bindDomEvents();
+      view.setOnCloseRequested(() => {
+        if (view.isCloseRequested()) {
+          view.destroy();
+        }
+      });
       view.openBundle({
         appId,
         files,

package/index.d.ts

@@ -195,6 +195,9 @@ export interface InkHostMessageStream {
   close(): void;
 }
 
+/** Callback invoked after the runtime requests that the host close the current view. */
+export type InkCloseRequestedHandler = () => void;
+
 /**
  * Initializes the browser SDK and ensures the wasm runtime is ready to create
  * views. Most applications can use {@link InkView.create} or
@@ -396,6 +399,18 @@ export declare class InkView {
   /** Returns whether the internal render loop is currently active. */
   isRunning(): boolean;
 
+  /**
+   * Registers the callback fired after Ink requests that the host close this view.
+   *
+   * When close is requested, the SDK marks the view as close-requested, stops
+   * the internal render loop automatically, and then invokes this callback.
+   * Pass `null` to clear the current callback.
+   */
+  setOnCloseRequested(callback: InkCloseRequestedHandler | null): this;
+
+  /** Returns whether Ink has already requested that the host close this view. */
+  isCloseRequested(): boolean;
+
   /**
    * Releases the underlying wasm view and detaches associated host resources.
    *

package/index.js

@@ -395,8 +395,10 @@ export class InkView {
   #animationFrameApi;
   #frameHandle;
   #autoRender;
+  #closeRequested;
   #destroyed;
   #domCleanup;
+  #onCloseRequested;
 
   constructor(rawView, options = {}) {
     this.#rawView = rawView;
@@ -404,8 +406,33 @@ export class InkView {
     this.#animationFrameApi = ensureAnimationFrameApi();
     this.#frameHandle = null;
     this.#autoRender = false;
+    this.#closeRequested = false;
     this.#destroyed = false;
     this.#domCleanup = null;
+    this.#onCloseRequested = null;
+  }
+
+  #resetCloseRequestedState() {
+    this.#closeRequested = false;
+  }
+
+  #consumeCloseRequested() {
+    if (this.#destroyed || this.#closeRequested) {
+      return this.#closeRequested;
+    }
+    if (typeof this.#rawView.consumeCloseRequested !== 'function') {
+      return false;
+    }
+    if (!this.#rawView.consumeCloseRequested()) {
+      return false;
+    }
+
+    this.#closeRequested = true;
+    this.stopRendering();
+    if (typeof this.#onCloseRequested === 'function') {
+      this.#onCloseRequested();
+    }
+    return true;
   }
 
   bindCanvas(canvas) {
@@ -559,13 +586,16 @@ export class InkView {
       throw new Error('`appId` must be a non-empty string.');
     }
 
+    this.#resetCloseRequestedState();
     this.#rawView.openBundle(
       appId,
       normalizeBundleFiles(files),
       initialPage,
       serializeQuery(query),
     );
-    this.requestRender();
+    if (!this.#consumeCloseRequested()) {
+      this.requestRender();
+    }
     return this;
   }
 
@@ -574,8 +604,11 @@ export class InkView {
       throw new Error('`path` must be a non-empty string.');
     }
 
+    this.#resetCloseRequestedState();
     this.#rawView.open(path.trim(), initialPage, serializeQuery(query));
-    this.requestRender();
+    if (!this.#consumeCloseRequested()) {
+      this.requestRender();
+    }
     return this;
   }
 
@@ -656,18 +689,19 @@ export class InkView {
   }
 
   render() {
-    if (this.#destroyed) {
+    if (this.#destroyed || this.#closeRequested) {
       return false;
     }
     const hasMoreWork = Boolean(this.#rawView.render());
-    if (hasMoreWork || this.#autoRender) {
+    const closeRequested = this.#consumeCloseRequested();
+    if (!closeRequested && (hasMoreWork || this.#autoRender)) {
       this.requestRender();
     }
-    return hasMoreWork;
+    return !closeRequested && hasMoreWork;
   }
 
   requestRender() {
-    if (this.#destroyed) {
+    if (this.#destroyed || this.#closeRequested) {
       return this;
     }
     if (this.#frameHandle != null) {
@@ -682,6 +716,9 @@ export class InkView {
   }
 
   startRendering() {
+    if (this.#closeRequested) {
+      return this;
+    }
     this.#autoRender = true;
     this.requestRender();
     return this;
@@ -697,7 +734,19 @@ export class InkView {
   }
 
   isRunning() {
-    return Boolean(this.#rawView.isRunning());
+    return !this.#closeRequested && Boolean(this.#rawView.isRunning());
+  }
+
+  setOnCloseRequested(callback) {
+    if (callback != null && typeof callback !== 'function') {
+      throw new TypeError('`callback` must be a function or null.');
+    }
+    this.#onCloseRequested = callback || null;
+    return this;
+  }
+
+  isCloseRequested() {
+    return this.#closeRequested;
   }
 
   destroy() {

package/package.json

@@ -10,7 +10,7 @@
     "access": "public",
     "registry": "https://registry.npmjs.com/"
   },
-  "version": "0.7.0",
+  "version": "0.8.0",
   "type": "module",
   "main": "index.js",
   "types": "index.d.ts",

package/pkg/ink_web.d.ts

@@ -14,6 +14,7 @@ export class InkWebView {
     [Symbol.dispose](): void;
     bindCanvas(canvas: HTMLCanvasElement): void;
     blur(): void;
+    consumeCloseRequested(): boolean;
     createMessageStream(origin: string, last_event_id: string): InkWebMessageStream;
     destroy(): void;
     dispatchInput(event_type: string, code: string, timestamp: number): void;
@@ -46,6 +47,7 @@ export interface InitOutput {
     readonly inkwebmessagestream_write: (a: number, b: number, c: number, d: number) => void;
     readonly inkwebview_bindCanvas: (a: number, b: number, c: number) => void;
     readonly inkwebview_blur: (a: number) => void;
+    readonly inkwebview_consumeCloseRequested: (a: number) => number;
     readonly inkwebview_createMessageStream: (a: number, b: number, c: number, d: number, e: number) => number;
     readonly inkwebview_destroy: (a: number) => void;
     readonly inkwebview_dispatchInput: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
@@ -62,11 +64,11 @@ export interface InitOutput {
     readonly inkwebview_resize: (a: number, b: number, c: number, d: number) => void;
     readonly inkwebview_setInteractive: (a: number, b: number) => void;
     readonly main: () => void;
-    readonly __wasm_bindgen_func_elem_9251: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_13498: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_9547: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_13499: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_9546: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_9308: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_13493: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_9474: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_13494: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_9475: (a: number, b: number) => void;
     readonly __wbindgen_export: (a: number, b: number) => number;
     readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
     readonly __wbindgen_export3: (a: number) => void;

package/pkg/ink_web.js

@@ -72,6 +72,13 @@ export class InkWebView {
     blur() {
         wasm.inkwebview_blur(this.__wbg_ptr);
     }
+    /**
+     * @returns {boolean}
+     */
+    consumeCloseRequested() {
+        const ret = wasm.inkwebview_consumeCloseRequested(this.__wbg_ptr);
+        return ret !== 0;
+    }
     /**
      * @param {string} origin
      * @param {string} last_event_id
@@ -1087,28 +1094,28 @@ function __wbg_get_imports() {
             return ret;
         },
         __wbindgen_cast_0000000000000001: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { dtor_idx: 2443, function: Function { arguments: [NamedExternref("CloseEvent")], shim_idx: 2403, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
-            const ret = makeMutClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_9251, __wasm_bindgen_func_elem_9547);
+            // Cast intrinsic for `Closure(Closure { dtor_idx: 2519, function: Function { arguments: [NamedExternref("CloseEvent")], shim_idx: 2472, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+            const ret = makeMutClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_9308, __wasm_bindgen_func_elem_9474);
             return addHeapObject(ret);
         },
         __wbindgen_cast_0000000000000002: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { dtor_idx: 2443, function: Function { arguments: [NamedExternref("Event")], shim_idx: 2403, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
-            const ret = makeMutClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_9251, __wasm_bindgen_func_elem_9547);
+            // Cast intrinsic for `Closure(Closure { dtor_idx: 2519, function: Function { arguments: [NamedExternref("Event")], shim_idx: 2472, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+            const ret = makeMutClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_9308, __wasm_bindgen_func_elem_9474);
             return addHeapObject(ret);
         },
         __wbindgen_cast_0000000000000003: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { dtor_idx: 2443, function: Function { arguments: [NamedExternref("MessageEvent")], shim_idx: 2403, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
-            const ret = makeMutClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_9251, __wasm_bindgen_func_elem_9547);
+            // Cast intrinsic for `Closure(Closure { dtor_idx: 2519, function: Function { arguments: [NamedExternref("MessageEvent")], shim_idx: 2472, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+            const ret = makeMutClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_9308, __wasm_bindgen_func_elem_9474);
             return addHeapObject(ret);
         },
         __wbindgen_cast_0000000000000004: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { dtor_idx: 2443, function: Function { arguments: [], shim_idx: 2445, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
-            const ret = makeMutClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_9251, __wasm_bindgen_func_elem_9546);
+            // Cast intrinsic for `Closure(Closure { dtor_idx: 2519, function: Function { arguments: [], shim_idx: 2521, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+            const ret = makeMutClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_9308, __wasm_bindgen_func_elem_9475);
             return addHeapObject(ret);
         },
         __wbindgen_cast_0000000000000005: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { dtor_idx: 3416, function: Function { arguments: [Externref], shim_idx: 3417, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
-            const ret = makeMutClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_13498, __wasm_bindgen_func_elem_13499);
+            // Cast intrinsic for `Closure(Closure { dtor_idx: 3419, function: Function { arguments: [Externref], shim_idx: 3420, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+            const ret = makeMutClosure(arg0, arg1, wasm.__wasm_bindgen_func_elem_13493, __wasm_bindgen_func_elem_13494);
             return addHeapObject(ret);
         },
         __wbindgen_cast_0000000000000006: function(arg0) {
@@ -1165,16 +1172,16 @@ function __wbg_get_imports() {
     };
 }
 
-function __wasm_bindgen_func_elem_9546(arg0, arg1) {
-    wasm.__wasm_bindgen_func_elem_9546(arg0, arg1);
+function __wasm_bindgen_func_elem_9475(arg0, arg1) {
+    wasm.__wasm_bindgen_func_elem_9475(arg0, arg1);
 }
 
-function __wasm_bindgen_func_elem_9547(arg0, arg1, arg2) {
-    wasm.__wasm_bindgen_func_elem_9547(arg0, arg1, addHeapObject(arg2));
+function __wasm_bindgen_func_elem_9474(arg0, arg1, arg2) {
+    wasm.__wasm_bindgen_func_elem_9474(arg0, arg1, addHeapObject(arg2));
 }
 
-function __wasm_bindgen_func_elem_13499(arg0, arg1, arg2) {
-    wasm.__wasm_bindgen_func_elem_13499(arg0, arg1, addHeapObject(arg2));
+function __wasm_bindgen_func_elem_13494(arg0, arg1, arg2) {
+    wasm.__wasm_bindgen_func_elem_13494(arg0, arg1, addHeapObject(arg2));
 }
 
 

package/pkg/ink_web_bg.wasm.d.ts

@@ -8,6 +8,7 @@ export const inkwebmessagestream_close: (a: number) => void;
 export const inkwebmessagestream_write: (a: number, b: number, c: number, d: number) => void;
 export const inkwebview_bindCanvas: (a: number, b: number, c: number) => void;
 export const inkwebview_blur: (a: number) => void;
+export const inkwebview_consumeCloseRequested: (a: number) => number;
 export const inkwebview_createMessageStream: (a: number, b: number, c: number, d: number, e: number) => number;
 export const inkwebview_destroy: (a: number) => void;
 export const inkwebview_dispatchInput: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
@@ -24,11 +25,11 @@ export const inkwebview_render: (a: number, b: number) => void;
 export const inkwebview_resize: (a: number, b: number, c: number, d: number) => void;
 export const inkwebview_setInteractive: (a: number, b: number) => void;
 export const main: () => void;
-export const __wasm_bindgen_func_elem_9251: (a: number, b: number) => void;
-export const __wasm_bindgen_func_elem_13498: (a: number, b: number) => void;
-export const __wasm_bindgen_func_elem_9547: (a: number, b: number, c: number) => void;
-export const __wasm_bindgen_func_elem_13499: (a: number, b: number, c: number) => void;
-export const __wasm_bindgen_func_elem_9546: (a: number, b: number) => void;
+export const __wasm_bindgen_func_elem_9308: (a: number, b: number) => void;
+export const __wasm_bindgen_func_elem_13493: (a: number, b: number) => void;
+export const __wasm_bindgen_func_elem_9474: (a: number, b: number, c: number) => void;
+export const __wasm_bindgen_func_elem_13494: (a: number, b: number, c: number) => void;
+export const __wasm_bindgen_func_elem_9475: (a: number, b: number) => void;
 export const __wbindgen_export: (a: number, b: number) => number;
 export const __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
 export const __wbindgen_export3: (a: number) => void;