@antha/input 0.18.0 → 0.20.0

package/dist/bindings/antha-menu-state.mod.d.ts

@@ -1,13 +1,13 @@
 import { type AnthaReadRawInputModState } from '../raw-inputs/antha-read-raw-input.mod.js';
 import { type MenuNavModState } from './antha-menu-nav.mod.js';
 /**
- * Menu navigation state with an optional parent destination for back navigation.
+ * Menu navigation state whose return path lists parent menus from the outermost to the nearest.
  *
  * @category Internal
  */
 export type AnthaMenuState<MenuKey extends string = string> = {
     activeMenu: MenuKey | undefined;
-    returnTo: MenuKey | undefined;
+    returnTo: MenuKey[];
 };
 /**
  * State consumed or updated by {@link createAnthaMenuStateMod}.
@@ -18,13 +18,21 @@ export type AnthaMenuStateModState<MenuKey extends string = string> = MenuNavMod
     menuState: AnthaMenuState<MenuKey> | undefined;
 };
 /**
- * Returns the parent menu, or closes menu mode when there is no parent.
+ * Returns to the nearest parent menu and removes it from the path, or closes menu mode when the
+ * path is empty.
  *
  * @category Internal
  */
-export declare function getAnthaMenuReturnState<MenuKey extends string>(returnTo: MenuKey | undefined): {
-    activeMenu: MenuKey | undefined;
-    returnTo: undefined;
+export declare function popAnthaMenuState<MenuKey extends string>(currentState: Readonly<AnthaMenuState<MenuKey>> | undefined): AnthaMenuState<MenuKey>;
+/**
+ * Opens `submenu` and appends the current menu to the return path so backing out of `submenu`
+ * returns to it. When no menu is open, `submenu` opens with an empty return path.
+ *
+ * @category Internal
+ */
+export declare function pushAnthaMenuState<MenuKey extends string>(currentState: Readonly<AnthaMenuState<MenuKey>> | undefined, submenu: NoInfer<MenuKey>): {
+    activeMenu: MenuKey;
+    returnTo: MenuKey[];
 };
 /**
  * Resolves pause and back inputs into a menu-state transition.
@@ -36,10 +44,7 @@ export declare function getAnthaMenuStateForNavigation<MenuKey extends string>({
     menuState: Readonly<AnthaMenuState<MenuKey>> | undefined;
     openPauseMenuWasTriggered: boolean;
     pauseMenu: MenuKey;
-}>): {
-    activeMenu: MenuKey | undefined;
-    returnTo: undefined;
-} | undefined;
+}>): AnthaMenuState<MenuKey> | undefined;
 /**
  * Switches the raw-input consumer and menu-navigation state on pause/back inputs. Add this before
  * `createAnthaMenuNavMod` so navigation sees the updated `isInMenu` value.

package/dist/bindings/antha-menu-state.mod.js

@@ -3,14 +3,30 @@ import { check } from '@augment-vir/assert';
 import { getObjectTypedEntries } from '@augment-vir/common';
 import { isPlayerMenuNavigationAllowed, MenuNavBinding, } from './antha-menu-nav.mod.js';
 /**
- * Returns the parent menu, or closes menu mode when there is no parent.
+ * Returns to the nearest parent menu and removes it from the path, or closes menu mode when the
+ * path is empty.
  *
  * @category Internal
  */
-export function getAnthaMenuReturnState(returnTo) {
+export function popAnthaMenuState(currentState) {
     return {
-        activeMenu: returnTo,
-        returnTo: undefined,
+        activeMenu: currentState?.returnTo.at(-1),
+        returnTo: currentState?.returnTo.slice(0, -1) || [],
+    };
+}
+/**
+ * Opens `submenu` and appends the current menu to the return path so backing out of `submenu`
+ * returns to it. When no menu is open, `submenu` opens with an empty return path.
+ *
+ * @category Internal
+ */
+export function pushAnthaMenuState(currentState, submenu) {
+    return {
+        activeMenu: submenu,
+        returnTo: [
+            ...(currentState?.returnTo || []),
+            ...(check.isDefined(currentState?.activeMenu) ? [currentState.activeMenu] : []),
+        ],
     };
 }
 /**
@@ -24,12 +40,12 @@ export function getAnthaMenuStateForNavigation({ menuExitWasTriggered, menuState
         return openPauseMenuWasTriggered
             ? {
                 activeMenu: pauseMenu,
-                returnTo: undefined,
+                returnTo: [],
             }
             : undefined;
     }
     return openPauseMenuWasTriggered || menuExitWasTriggered
-        ? getAnthaMenuReturnState(menuState?.returnTo)
+        ? popAnthaMenuState(menuState)
         : undefined;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@antha/input",
-    "version": "0.18.0",
+    "version": "0.20.0",
     "description": "An Antha mod for handling inputs.",
     "keywords": [
         "vir",
@@ -42,8 +42,8 @@
         "vira": "^32.0.0"
     },
     "devDependencies": {
-        "@antha/engine": "^0.18.0",
-        "@antha/gamepad-type": "^0.18.0",
+        "@antha/engine": "^0.20.0",
+        "@antha/gamepad-type": "^0.20.0",
         "@augment-vir/test": "^32.3.0",
         "@web/dev-server-esbuild": "^2.0.0",
         "@web/test-runner": "^1.0.0",
@@ -54,8 +54,8 @@
         "typedoc": "^0.28.20"
     },
     "peerDependencies": {
-        "@antha/engine": "^0.18.0",
-        "@antha/gamepad-type": "^0.18.0",
+        "@antha/engine": "^0.20.0",
+        "@antha/gamepad-type": "^0.20.0",
         "element-vir": "^27"
     },
     "engines": {