pi-keyboard 0.1.4 → 0.1.6

package/README.md

@@ -29,6 +29,24 @@ Supports discrete control for keyboard lighting channels:
 
 ---
 
+## Structure
+
+```
+keyboard/
+├── index.ts           — Package-root extension entry point
+├── src/
+│   ├── config.ts      — Keyboard config read/write helpers
+│   ├── driver.ts      — via-rgb binary resolution & CLI execution
+│   ├── protocol.ts    — VIA RAW HID packet building
+│   ├── state-machine.ts — State transitions and LED apply logic
+│   ├── global-sessions.ts — Per-cwd session glow record registry
+│   ├── types.ts       — KeyboardState, KeyboardZone, KeyboardConfig
+│   └── index.ts       — Pi lifecycle hooks, /keyboard command
+├── features/          — BDD contract
+├── tests/             — Package E2E tests
+└── README.md
+```
+
 ## Installation
 
 Install from this monorepo or local path:
@@ -37,7 +55,7 @@ Install from this monorepo or local path:
 pi install ~/Developer/FradSer/pi-packages/packages/keyboard
 ```
 
-When published to npm:
+Published on npm:
 
 ```bash
 pi install npm:pi-keyboard

package/features/keyboard.feature

@@ -134,3 +134,7 @@ Feature: Pi Keyboard Lighting Indicator
     Then all keyboard lighting updates are disabled
     When the user runs "/keyboard test thinking"
     Then the keyboard lighting displays the blue thinking state
+
+  Scenario: Keyboard state notifications use Pi's native notification surface
+    Given the keyboard extension reports an interactive command outcome
+    Then it uses ctx.ui.notify without a custom notification renderer

package/index.ts

@@ -0,0 +1 @@
+export { default } from "./src/index.ts";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-keyboard",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "Dynamic VIA/QMK keyboard RGB lighting indicator reflecting Pi states (idle, thinking, unread, need-approval, error)",
   "author": "Frad LEE <fradser@gmail.com>",
   "license": "MIT",
@@ -22,6 +22,7 @@
     "access": "public"
   },
   "files": [
+    "index.ts",
     "src",
     "features",
     "README.md",
@@ -29,11 +30,14 @@
   ],
   "pi": {
     "extensions": [
-      "./src/index.ts"
+      "./index.ts"
     ]
   },
   "peerDependencies": {
     "@earendil-works/pi-coding-agent": "*",
     "@earendil-works/pi-tui": "*"
+  },
+  "dependencies": {
+    "@fradser/pi-kit": "0.4.2"
   }
 }

package/src/index.ts

@@ -2,12 +2,12 @@ import type {
   ExtensionAPI,
   ExtensionCommandContext,
 } from "@earendil-works/pi-coding-agent";
+import { notifyPi } from "@fradser/pi-kit";
 import { readKeyboardConfig, writeKeyboardConfig } from "./config";
 import { fetchKeyboardStatus } from "./driver";
 import { KeyboardStateMachine } from "./state-machine";
 import {
   KEYBOARD_STATE_DEFINITIONS,
-  type KeyboardConfig,
   type KeyboardState,
   type KeyboardZone,
 } from "./types";
@@ -148,14 +148,14 @@ export default function (pi: ExtensionAPI): void {
       if (trimmed === "on") {
         sm.updateConfig({ enabled: true });
         writeKeyboardConfig(sm.getConfig());
-        ctx.ui.notify("Keyboard lighting indicator enabled", "info");
+        notifyPi(ctx.ui, "Keyboard lighting indicator enabled", "info");
         return;
       }
 
       if (trimmed === "off") {
         sm.updateConfig({ enabled: false });
         writeKeyboardConfig(sm.getConfig());
-        ctx.ui.notify("Keyboard lighting indicator disabled", "info");
+        notifyPi(ctx.ui, "Keyboard lighting indicator disabled", "info");
         return;
       }
 
@@ -169,9 +169,9 @@ export default function (pi: ExtensionAPI): void {
         const targetState = (parts[1] || "thinking") as KeyboardState;
         if (targetState in KEYBOARD_STATE_DEFINITIONS) {
           await sm.transitionTo(targetState, true);
-          ctx.ui.notify(`Testing state: ${KEYBOARD_STATE_DEFINITIONS[targetState].labelZh}`, "info");
+          notifyPi(ctx.ui, `Testing state: ${KEYBOARD_STATE_DEFINITIONS[targetState].labelZh}`, "info");
         } else {
-          ctx.ui.notify(`Unknown test state. Options: ${Object.keys(KEYBOARD_STATE_DEFINITIONS).join(", ")}`, "error");
+          notifyPi(ctx.ui, `Unknown test state. Options: ${Object.keys(KEYBOARD_STATE_DEFINITIONS).join(", ")}`, "error");
         }
         return;
       }
@@ -195,7 +195,7 @@ async function showStatus(ctx: ExtensionCommandContext, sm: KeyboardStateMachine
     `Hardware Status  : ${hw.connected ? `Connected (${hw.device?.product || "VIA Keyboard"})` : "Not connected / Not detected"}`,
   ];
 
-  ctx.ui.notify(lines.join("\n"), "info");
+  notifyPi(ctx.ui, lines.join("\n"), "info");
 }
 
 async function openKeyboardMenu(
@@ -225,7 +225,7 @@ async function openKeyboardMenu(
     const next = !config.enabled;
     sm.updateConfig({ enabled: next });
     writeKeyboardConfig(sm.getConfig());
-    ctx.ui.notify(`Keyboard lighting indicator is now ${next ? "ON" : "OFF"}`, "info");
+    notifyPi(ctx.ui, `Keyboard lighting indicator is now ${next ? "ON" : "OFF"}`, "info");
     return;
   }
 
@@ -238,7 +238,7 @@ async function openKeyboardMenu(
       const chosenState = stateKeys[idx];
       if (chosenState) {
         await sm.transitionTo(chosenState, true);
-        ctx.ui.notify(`Applied state: ${KEYBOARD_STATE_DEFINITIONS[chosenState].labelZh}`, "info");
+        notifyPi(ctx.ui, `Applied state: ${KEYBOARD_STATE_DEFINITIONS[chosenState].labelZh}`, "info");
       }
     }
     return;
@@ -260,7 +260,7 @@ async function openKeyboardMenu(
       const zone = zoneMap[zoneChoice] || "all";
       sm.updateConfig({ zone });
       writeKeyboardConfig(sm.getConfig());
-      ctx.ui.notify(`Active zone set to: ${zone.toUpperCase()}`, "info");
+      notifyPi(ctx.ui, `Active zone set to: ${zone.toUpperCase()}`, "info");
     }
     return;
   }
@@ -278,7 +278,7 @@ async function openKeyboardMenu(
       const scale = scaleMap[scaleChoice] ?? 1.0;
       sm.updateConfig({ brightnessScale: scale });
       writeKeyboardConfig(sm.getConfig());
-      ctx.ui.notify(`Brightness scale set to ${Math.round(scale * 100)}%`, "info");
+      notifyPi(ctx.ui, `Brightness scale set to ${Math.round(scale * 100)}%`, "info");
     }
     return;
   }

package/src/state-machine.ts

@@ -107,7 +107,7 @@ export class KeyboardStateMachine {
     await this.applyCurrentState(force);
   }
 
-  private async applyCurrentState(force = false): Promise<void> {
+  private async applyCurrentState(_force = false): Promise<void> {
     await applyKeyboardState(this.currentState, this.config);
   }