@runmu.sh/ext-scene 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 1.2.0
+
+- Alt+R (*Go to scene*) is now the extension's own command, `focus.scene`, in Settings → Keys under Scene: Focus. On μClient with extension API 1.14 it focuses the Scene panel when it is open; a rebinding you made keeps working. On an older μClient the client's own Alt+R stays in place.
+- The context menus on exits and room items use the kinds `scene.exit` (`data: { exit }`) and `scene.item` (`data: { item }`), which the extension registers with a schema. On a μClient before API 1.14 it keeps publishing `scene-exit` and `scene-item`.
+- `src/types.ts` types the two kinds for other extensions (`ContextKinds`, `SceneItemData`, `SceneExitData`), and the module exports `ITEM_KIND`, `EXIT_KIND` and `KIND_SCHEMAS`.
+- Built against SDK 1.14. Still needs extension API 1.12 or later.
+
 ## 1.1.0
 
 - Present now comes before Exits, and a room with no exits shows no Exits heading at all, as on Underspire.

package/README.md

@@ -22,13 +22,13 @@ Package names are case-insensitive. Entering a new room clears Present. The room
 ## What it looks like
 On `--bg-elev`: the title in uppercase `--accent-bright` with a glow and a `--border-bright` rule under it, the area in small faint capitals, the atmosphere in italic `--fg-dim`, the description, and the pose line in italic with a 2px left rule. Then `┤PRESENT├` over a `▸` list of the people and room items present (a hostile item carries a small `hostile` tag in `--alert`; nobody reads `none`), and, when the room has exits, `┤EXITS├` over a `▸` list. Each exit is a button: clicking it sends the direction as if typed. Before any room arrives the panel says NO ROOM YET (an upright, uppercase, tracked faint label).
 
-The panel is the region `scene`, so **Alt+R** (*Go to scene*) focuses it.
+The panel is the region `scene`. **Alt+R** (*Go to scene*, command `focus.scene`) focuses it; rebind it in Settings → Keys. From 1.2.0 the extension registers the command itself (μClient with extension API 1.14); on an older μClient the client's own Alt+R does the same.
 
 ## Behaviour
 - Panel `scene`, singleton, default position right top, Views order 10 (after Terminal, before Channels).
 - **Show panel: auto** (per world, on the extension's settings page: off / auto / on). On auto the Scene joins Views and adds itself the first time a session knows its room, whatever the room came from (GMCP, MSDP, another extension); once per world on this device, so a Scene you closed stays closed.
 - A redraw in the same room (someone arrives, an item drops) keeps your scroll position; moving to another room scrolls back to the top. When the game sends no room id, every update counts as a move.
-- Right-click (or long-press) an exit or a room item for the menus other extensions add to them (`scene-exit` and `scene-item` targets).
+- Right-click (or long-press) an exit or a room item for the menus other extensions add to them. The extension registers the context kinds `scene.exit` (title *Exit*, `data: { exit }`) and `scene.item` (title *Scene item*, `data: { item: { id, name, hostile? } }`), each with a schema the host checks. On a μClient before API 1.14 it publishes the 1.12 kinds `scene-exit` and `scene-item` instead; on 1.14 an entry written for the old kinds still receives the new targets in the old shape.
 - It sends nothing to the game except the exits you click, and reads no GMCP itself: the room adapters fill the scene.
 
 ## Contract
@@ -42,9 +42,12 @@ No `ctx.exports` API. The module exports, for tests and other renderers:
 | `renderScene(scene, go, opts?)` | The panel's children for one `SceneView` (`null` or `known: false` → NO ROOM YET). `go(dir)` is called on an exit click. `opts.css` passes the host classes (`mu.ui.css`), `opts.target(el, what)` is called for each exit button and present row (to mark context targets). The 1.0 two-argument form still works. |
 | `presentOf(scene)` | People first, then room items, each name once: `{ name, hostile? }[]`. |
 | `COPY`, `SCENE_CSS` | The drawn copy and the stylesheet (every rule under `.ext-panel[data-ext="scene"] .mu-scene`). |
+| `ITEM_KIND`, `EXIT_KIND`, `KIND_SCHEMAS` | `'scene.item'`, `'scene.exit'` and their `data` schemas. |
+
+`src/types.ts` augments the SDK's `ContextKinds` with `scene.item` (`SceneItemData`) and `scene.exit` (`SceneExitData`), so an extension that imports it gets `t.data` typed in `mu.menus.context({ target: 'scene.exit', … })`.
 
 ## SDK
-SDK 1.12: `mu.panels.register` with `show: 'auto'`, `mu.panels.touch`, `mu.sessions.each`, `mu.scene.watch` (and `SceneView.id`), `mu.sessions.send(dir, { sid })`, `mu.menus.target`, `h` and `mu.ui.css`, `mu.ui.style`.
+`api` `^1.12`. SDK 1.12: `mu.panels.register` with `show: 'auto'`, `mu.panels.touch`, `mu.sessions.each`, `mu.scene.watch` (and `SceneView.id`), `mu.sessions.send(dir, { sid })`, `mu.menus.target`, `h` and `mu.ui.css`, `mu.ui.style`. SDK 1.14, used when the host has them: `mu.menus.kind` (with `JsonSchema` and `ContextKinds`), `mu.panels.focus` with `mu.commands.register`. The manifest declares `focus.scene` in `contributes.commands`, so Alt+R is listed and bound before the extension activates.
 
 ## Develop
 Made with `npm create @runmu.sh/extension` ([the quickstart](https://runmu.sh/docs/extensions/quickstart)).

package/dist/index.js

@@ -1,5 +1,11 @@
 // src/index.ts
 import { defineExtension, h } from "@muclient/sdk";
+
+// src/types.ts
+var ITEM_KIND = "scene.item";
+var EXIT_KIND = "scene.exit";
+
+// src/index.ts
 var COPY = {
   title: "Scene",
   awaiting: "No room yet",
@@ -7,7 +13,18 @@ var COPY = {
   exits: "Exits",
   none: "none",
   hostile: "hostile",
-  go: (dir) => `go ${dir}`
+  go: (dir) => `go ${dir}`,
+  focus: "Go to scene",
+  itemKind: "Scene item",
+  exitKind: "Exit"
+};
+var KIND_SCHEMAS = {
+  [ITEM_KIND]: {
+    type: "object",
+    required: ["item"],
+    properties: { item: { type: "object", required: ["id", "name"], properties: { id: { type: "string" }, name: { type: "string" }, hostile: { type: "boolean" } } } }
+  },
+  [EXIT_KIND]: { type: "object", required: ["exit"], properties: { exit: { type: "string" } } }
 };
 var R = '.ext-panel[data-ext="scene"] .mu-scene';
 var SCENE_CSS = `
@@ -85,6 +102,15 @@ var index_default = defineExtension({
     const mu = ctx.mu;
     mu.ui.style(SCENE_CSS);
     const css = { secHead: mu.ui.css.secHead, secClose: mu.ui.css.secClose, empty: mu.ui.css.empty, glow: mu.ui.css.glow };
+    const kinds = typeof mu.menus.kind === "function";
+    if (kinds) {
+      ctx.subscriptions.push(
+        mu.menus.kind({ id: ITEM_KIND, title: COPY.itemKind, schema: KIND_SCHEMAS[ITEM_KIND] }),
+        mu.menus.kind({ id: EXIT_KIND, title: COPY.exitKind, schema: KIND_SCHEMAS[EXIT_KIND] })
+      );
+    }
+    const exitTarget = (sid, exit) => kinds ? { kind: EXIT_KIND, sid, data: { exit } } : { kind: "scene-exit", sid, exit };
+    const itemTarget = (sid, item) => kinds ? { kind: ITEM_KIND, sid, data: { item } } : { kind: "scene-item", sid, item };
     const mount = (host, pc) => {
       const root = h("section", { class: "mu-scene", "aria-label": COPY.title, "data-focus-region": "scene", tabindex: "-1", "data-testid": "scene" });
       host.append(root);
@@ -103,8 +129,8 @@ var index_default = defineExtension({
         targets = [];
       };
       const target = (el, what) => {
-        if ("exit" in what) targets.push(mu.menus.target(el, { kind: "scene-exit", sid, exit: what.exit }));
-        else if ("item" in what) targets.push(mu.menus.target(el, { kind: "scene-item", sid, item: what.item }));
+        if ("exit" in what) targets.push(mu.menus.target(el, exitTarget(sid, what.exit)));
+        else if ("item" in what) targets.push(mu.menus.target(el, itemTarget(sid, what.item)));
       };
       let room = null;
       const off = mu.scene.watch((s) => {
@@ -122,6 +148,11 @@ var index_default = defineExtension({
       };
     };
     mu.panels.register({ id: "scene", title: COPY.title, singleton: true, defaultPosition: "right-top", order: 10, show: "auto", mount });
+    if (typeof mu.panels.focus === "function") {
+      mu.commands.register({ id: "focus.scene", title: COPY.focus, keys: ["Alt+R"], group: "Focus", when: "session", run: () => {
+        mu.panels.focus?.("scene");
+      } });
+    }
     ctx.subscriptions.push(mu.sessions.each((s) => {
       let done = false;
       return mu.scene.watch((v) => {
@@ -135,6 +166,9 @@ var index_default = defineExtension({
 });
 export {
   COPY,
+  EXIT_KIND,
+  ITEM_KIND,
+  KIND_SCHEMAS,
   SCENE_CSS,
   index_default as default,
   presentOf,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runmu.sh/ext-scene",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "The Scene panel: the room you are in (title, area, atmosphere, description, pose), who is present and its exits as buttons, from GMCP Room.*, Char.Items.*, MSDP or another extension.",
   "keywords": [
     "scene",
@@ -35,11 +35,11 @@
     "test": "node --test test/*.test.mjs"
   },
   "devDependencies": {
-    "@muclient/sdk": "npm:@runmu.sh/sdk@^1.12.0",
-    "@runmu.sh/dev": "^0.2.0",
+    "@muclient/sdk": "npm:@runmu.sh/sdk@^1.14.0",
+    "@runmu.sh/dev": "^0.3.0",
     "esbuild": "^0.28.2",
-    "typescript": "^5.9.0",
-    "happy-dom": "^20.0.0"
+    "happy-dom": "^20.0.0",
+    "typescript": "^5.9.0"
   },
   "engines": {
     "node": ">=20"
@@ -63,6 +63,15 @@
           "defaultPosition": "right-top",
           "singleton": true
         }
+      ],
+      "commands": [
+        {
+          "id": "focus.scene",
+          "title": "Go to scene",
+          "keys": [
+            "Alt+R"
+          ]
+        }
       ]
     },
     "capabilities": [

package/src/types.ts

@@ -42,4 +42,30 @@ export interface SceneCopy {
   none: string;
   hostile: string;
   go(dir: string): string;
+  /** The `focus.scene` command's title. @since 1.2.0 */
+  focus: string;
+  /** The context kinds' titles (the menu's accessible label). @since 1.2.0 */
+  itemKind: string;
+  exitKind: string;
+}
+
+/** The context kind of a room item in ┤PRESENT├ (SDK 1.14). @since 1.2.0 */
+export const ITEM_KIND = 'scene.item';
+/** The context kind of an exit button (SDK 1.14). @since 1.2.0 */
+export const EXIT_KIND = 'scene.exit';
+
+/** `data` of a `scene.item` target. @since 1.2.0 */
+export interface SceneItemData { item: SceneView['items'][number] }
+/** `data` of a `scene.exit` target. @since 1.2.0 */
+export interface SceneExitData { exit: string }
+
+/**
+ * Types `t.data` in another extension's `mu.menus.context({ target: 'scene.item' | 'scene.exit', … })` once it
+ * imports this file. @since 1.2.0
+ */
+declare module '@muclient/sdk' {
+  interface ContextKinds {
+    'scene.item': SceneItemData;
+    'scene.exit': SceneExitData;
+  }
 }