@jdg-keyforge/protocol 0.9.0 → 0.10.0

package/dist/common.d.ts

@@ -24,6 +24,21 @@ export type InputKind = "key" | "encoder";
  * via the `definition` "InputAction".
  */
 export type InputAction = "press" | "release" | "rotate_cw" | "rotate_ccw" | "click";
+/**
+ * Globally unique plugin identifier in reverse-DNS form (e.g. 'dev.jonidg.spotify'). Lowercase, at least two dot-separated segments, each starting with a letter. Used as the install folder name and as <plugin_id> in Action.type.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "PluginID".
+ */
+export type PluginID = string;
+/**
+ * Id of the plugin being launched (its manifest id).
+ */
+export type PluginID1 = string;
+/**
+ * Globally unique reverse-DNS plugin id; install folder name and <plugin_id> in Action.type.
+ */
+export type PluginID2 = string;
 /**
  * Shared type definitions referenced by message schemas.
  */
@@ -268,6 +283,23 @@ export interface ParamSpec {
      */
     placeholder?: string;
 }
+/**
+ * Connection info the daemon hands to a plugin process it spawns, serialized as JSON in the KEYFORGE_PLUGIN_INFO environment variable (an env var rather than CLI args, so the token is not visible in the process list). The plugin connects to ws_url, sends hello with client.name set to plugin_id, and must exit when that connection closes.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "PluginLaunchInfo".
+ */
+export interface PluginLaunchInfo {
+    plugin_id: PluginID1;
+    /**
+     * WebSocket URL to connect to, including the per-plugin auth token as a query param. Treat it as a secret: the token identifies the plugin to the daemon and is distinct from the GUI's session token.
+     */
+    ws_url: string;
+    /**
+     * Protocol major version the daemon speaks. The plugin sends it back in hello. Currently '1'.
+     */
+    protocol_version: "1";
+}
 /**
  * Contents of the manifest.json file at the root of a plugin. A plugin is distributed as a '.keyforgeplugin' file: a zip archive with manifest.json at its root (no wrapping folder) plus every file the manifest references. The daemon installs it by extracting the archive into '<config dir>/plugins/<id>/', taking the id from the manifest. All file paths in the manifest (icon, and entrypoint paths containing '/') are relative to the plugin root, use '/' as separator, and must stay inside the plugin root: the daemon rejects '..' segments and any path or archive entry that escapes the root.
  *
@@ -279,10 +311,7 @@ export interface PluginManifest {
      * Manifest format version. Currently 1; bumped if the manifest shape changes.
      */
     manifest_version: 1;
-    /**
-     * Globally unique plugin identifier in reverse-DNS form (e.g. 'dev.jonidg.spotify'). Lowercase, at least two dot-separated segments, each starting with a letter. Used as the install folder name and as <plugin_id> in Action.type.
-     */
-    id: string;
+    id: PluginID2;
     /**
      * Human-friendly plugin name for the UI.
      */

package/dist/events/action_invoked.d.ts

@@ -0,0 +1,60 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * Stable identifier for a HID device. Format: VID_<hex>_PID_<hex>[_<serial>].
+ */
+export type DeviceID = string;
+/**
+ * Kind of physical input.
+ */
+export type InputKind = "key" | "encoder";
+/**
+ * What happened on the input.
+ */
+export type InputAction = "press" | "release" | "rotate_cw" | "rotate_ccw" | "click";
+/**
+ * Sent by the daemon to a single plugin connection (never broadcast) when a binding or macro step whose action is 'plugin.<plugin_id>.<action_id>' fires for that plugin. Fire-and-forget: the daemon does not wait for the plugin, so a failing plugin action cannot stop a macro it is part of.
+ */
+export interface EventActionInvoked {
+    data: {
+        /**
+         * Opaque id of the binding instance that fired: unique per binding and per macro step, and stable for as long as that binding exists (also across daemon restarts). Lets a plugin keep per-instance state, e.g. a toggle bound to two keys. Plugins must not parse it.
+         */
+        context: string;
+        /**
+         * The plugin action to run.
+         */
+        action: {
+            /**
+             * Action id as declared in the plugin manifest (PluginAction.id), without the 'plugin.<plugin_id>.' prefix.
+             */
+            id: string;
+            /**
+             * Action.params from the binding, as configured by the user. Always present: {} when the binding has no params.
+             */
+            params: {
+                [k: string]: unknown;
+            };
+        };
+        input?: InputEvent;
+    };
+}
+/**
+ * Hardware event that fired the binding (e.g. lets a plugin tell rotate_cw from rotate_ccw). Absent when the action was not fired by hardware (e.g. a test run from the GUI).
+ */
+export interface InputEvent {
+    device_id: DeviceID;
+    kind: InputKind;
+    /**
+     * Logical identifier of the input within the device (e.g. 'key_0x04', 'encoder_0'). Matches Device.inputs[].id.
+     */
+    input_id: string;
+    action: InputAction;
+    /**
+     * Unix epoch in milliseconds when the event was captured by the daemon.
+     */
+    timestamp_ms: number;
+}

package/dist/events/action_invoked.js

@@ -0,0 +1,7 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+export {};

package/dist/index.d.ts

@@ -15,5 +15,6 @@ export type { MethodRenameProfile } from './methods/rename_profile.js';
 export type { MethodSetActiveProfile } from './methods/set_active_profile.js';
 export type { MethodSetAutoSwitch } from './methods/set_auto_switch.js';
 export type { MethodSetBinding } from './methods/set_binding.js';
+export type { EventActionInvoked } from './events/action_invoked.js';
 export type { EventActiveProfileChanged } from './events/active_profile_changed.js';
 export type { EventInput } from './events/input.js';

package/dist/methods/hello.d.ts

@@ -30,7 +30,7 @@ export interface MethodHello {
  */
 export interface PeerInfo {
     /**
-     * Stable identifier of the peer implementation.
+     * Stable identifier of the peer implementation. A plugin must send its PluginID here; the daemon checks it against the plugin its auth token belongs to.
      */
     name: string;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jdg-keyforge/protocol",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "TypeScript types for the KeyForge WebSocket protocol, generated from the canonical JSON Schema contracts.",
   "keywords": ["keyforge", "protocol", "types", "json-schema", "websocket"],
   "license": "Apache-2.0",

package/src/common.ts

@@ -26,6 +26,21 @@ export type InputKind = "key" | "encoder";
  * via the `definition` "InputAction".
  */
 export type InputAction = "press" | "release" | "rotate_cw" | "rotate_ccw" | "click";
+/**
+ * Globally unique plugin identifier in reverse-DNS form (e.g. 'dev.jonidg.spotify'). Lowercase, at least two dot-separated segments, each starting with a letter. Used as the install folder name and as <plugin_id> in Action.type.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "PluginID".
+ */
+export type PluginID = string;
+/**
+ * Id of the plugin being launched (its manifest id).
+ */
+export type PluginID1 = string;
+/**
+ * Globally unique reverse-DNS plugin id; install folder name and <plugin_id> in Action.type.
+ */
+export type PluginID2 = string;
 
 /**
  * Shared type definitions referenced by message schemas.
@@ -271,6 +286,23 @@ export interface ParamSpec {
    */
   placeholder?: string;
 }
+/**
+ * Connection info the daemon hands to a plugin process it spawns, serialized as JSON in the KEYFORGE_PLUGIN_INFO environment variable (an env var rather than CLI args, so the token is not visible in the process list). The plugin connects to ws_url, sends hello with client.name set to plugin_id, and must exit when that connection closes.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "PluginLaunchInfo".
+ */
+export interface PluginLaunchInfo {
+  plugin_id: PluginID1;
+  /**
+   * WebSocket URL to connect to, including the per-plugin auth token as a query param. Treat it as a secret: the token identifies the plugin to the daemon and is distinct from the GUI's session token.
+   */
+  ws_url: string;
+  /**
+   * Protocol major version the daemon speaks. The plugin sends it back in hello. Currently '1'.
+   */
+  protocol_version: "1";
+}
 /**
  * Contents of the manifest.json file at the root of a plugin. A plugin is distributed as a '.keyforgeplugin' file: a zip archive with manifest.json at its root (no wrapping folder) plus every file the manifest references. The daemon installs it by extracting the archive into '<config dir>/plugins/<id>/', taking the id from the manifest. All file paths in the manifest (icon, and entrypoint paths containing '/') are relative to the plugin root, use '/' as separator, and must stay inside the plugin root: the daemon rejects '..' segments and any path or archive entry that escapes the root.
  *
@@ -282,10 +314,7 @@ export interface PluginManifest {
    * Manifest format version. Currently 1; bumped if the manifest shape changes.
    */
   manifest_version: 1;
-  /**
-   * Globally unique plugin identifier in reverse-DNS form (e.g. 'dev.jonidg.spotify'). Lowercase, at least two dot-separated segments, each starting with a letter. Used as the install folder name and as <plugin_id> in Action.type.
-   */
-  id: string;
+  id: PluginID2;
   /**
    * Human-friendly plugin name for the UI.
    */

package/src/events/action_invoked.ts

@@ -0,0 +1,63 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * Stable identifier for a HID device. Format: VID_<hex>_PID_<hex>[_<serial>].
+ */
+export type DeviceID = string;
+/**
+ * Kind of physical input.
+ */
+export type InputKind = "key" | "encoder";
+/**
+ * What happened on the input.
+ */
+export type InputAction = "press" | "release" | "rotate_cw" | "rotate_ccw" | "click";
+
+/**
+ * Sent by the daemon to a single plugin connection (never broadcast) when a binding or macro step whose action is 'plugin.<plugin_id>.<action_id>' fires for that plugin. Fire-and-forget: the daemon does not wait for the plugin, so a failing plugin action cannot stop a macro it is part of.
+ */
+export interface EventActionInvoked {
+  data: {
+    /**
+     * Opaque id of the binding instance that fired: unique per binding and per macro step, and stable for as long as that binding exists (also across daemon restarts). Lets a plugin keep per-instance state, e.g. a toggle bound to two keys. Plugins must not parse it.
+     */
+    context: string;
+    /**
+     * The plugin action to run.
+     */
+    action: {
+      /**
+       * Action id as declared in the plugin manifest (PluginAction.id), without the 'plugin.<plugin_id>.' prefix.
+       */
+      id: string;
+      /**
+       * Action.params from the binding, as configured by the user. Always present: {} when the binding has no params.
+       */
+      params: {
+        [k: string]: unknown;
+      };
+    };
+    input?: InputEvent;
+  };
+}
+/**
+ * Hardware event that fired the binding (e.g. lets a plugin tell rotate_cw from rotate_ccw). Absent when the action was not fired by hardware (e.g. a test run from the GUI).
+ */
+export interface InputEvent {
+  device_id: DeviceID;
+  kind: InputKind;
+  /**
+   * Logical identifier of the input within the device (e.g. 'key_0x04', 'encoder_0'). Matches Device.inputs[].id.
+   */
+  input_id: string;
+  action: InputAction;
+  /**
+   * Unix epoch in milliseconds when the event was captured by the daemon.
+   */
+  timestamp_ms: number;
+}

package/src/index.ts

@@ -19,5 +19,6 @@ export type { MethodSetActiveProfile } from './methods/set_active_profile.js';
 export type { MethodSetAutoSwitch } from './methods/set_auto_switch.js';
 export type { MethodSetBinding } from './methods/set_binding.js';
 
+export type { EventActionInvoked } from './events/action_invoked.js';
 export type { EventActiveProfileChanged } from './events/active_profile_changed.js';
 export type { EventInput } from './events/input.js';

package/src/methods/hello.ts

@@ -32,7 +32,7 @@ export interface MethodHello {
  */
 export interface PeerInfo {
   /**
-   * Stable identifier of the peer implementation.
+   * Stable identifier of the peer implementation. A plugin must send its PluginID here; the daemon checks it against the plugin its auth token belongs to.
    */
   name: string;
   /**