@jdg-keyforge/protocol 0.6.0

package/src/methods/list_bindings.ts

@@ -0,0 +1,55 @@
+/* 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;
+/**
+ * What happened on the input.
+ */
+export type InputAction = "press" | "release" | "rotate_cw" | "rotate_ccw" | "click";
+
+/**
+ * Returns all bindings the daemon currently has configured. Read-side counterpart of set_binding. No filters in v1; clients filter client-side if needed.
+ */
+export interface MethodListBindings {
+  /**
+   * No parameters in v1.
+   */
+  params: {};
+  result: {
+    /**
+     * All currently configured bindings.
+     */
+    bindings: Binding[];
+  };
+}
+/**
+ * Maps an input on a specific device to an action.
+ */
+export interface Binding {
+  device_id: DeviceID;
+  input_id: string;
+  trigger: InputAction;
+  action: Action;
+}
+/**
+ * An executable action bound to an input.
+ */
+export interface Action {
+  /**
+   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+   */
+  type: string;
+  /**
+   * Action-specific parameters. Schema depends on 'type'.
+   */
+  params?: {
+    [k: string]: unknown;
+  };
+}

package/src/methods/list_devices.ts

@@ -0,0 +1,79 @@
+/* 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";
+
+/**
+ * Returns the HID devices currently known to the daemon. No filters in v1; clients filter client-side if needed.
+ */
+export interface MethodListDevices {
+  /**
+   * No parameters in v1.
+   */
+  params: {};
+  result: {
+    /**
+     * All currently enumerated HID devices.
+     */
+    devices: Device[];
+  };
+}
+/**
+ * A HID device known to the daemon. Returned by list_devices.
+ */
+export interface Device {
+  id: DeviceID;
+  /**
+   * USB Vendor ID as a 4-digit hexadecimal string (lowercase or uppercase, no '0x' prefix).
+   */
+  vendor_id: string;
+  /**
+   * USB Product ID as a 4-digit hexadecimal string (lowercase or uppercase, no '0x' prefix).
+   */
+  product_id: string;
+  /**
+   * Manufacturer string from the HID descriptor. May be missing on cheap/clone devices.
+   */
+  manufacturer?: string;
+  /**
+   * Product name string from the HID descriptor.
+   */
+  product?: string;
+  /**
+   * Serial number string from the HID descriptor. Not all HID devices expose one.
+   */
+  serial_number?: string;
+  /**
+   * OS-opaque path used by the HID library to (re)open the device. Format varies per OS; clients should treat it as an opaque token.
+   */
+  path: string;
+  /**
+   * Inputs (keys/encoders) the daemon knows this device exposes. Empty for unrecognized devices the daemon can't map.
+   */
+  inputs: Input[];
+}
+/**
+ * A single physical input exposed by a device (a key or an encoder).
+ */
+export interface Input {
+  /**
+   * Logical identifier of the input within the device (e.g. 'key_0x04', 'encoder_0'). Matches InputEvent.input_id and Binding.input_id.
+   */
+  id: string;
+  kind: InputKind;
+  /**
+   * Human-friendly label for the input (e.g. 'Key 1', 'Encoder'). Optional; clients fall back to id.
+   */
+  label?: string;
+}

package/src/methods/list_profiles.ts

@@ -0,0 +1,76 @@
+/* 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;
+/**
+ * What happened on the input.
+ */
+export type InputAction = "press" | "release" | "rotate_cw" | "rotate_ccw" | "click";
+
+/**
+ * Returns all profiles the daemon currently has, along with the id of the active one. The active profile id is tracked at the daemon level and only exposed here.
+ */
+export interface MethodListProfiles {
+  /**
+   * No parameters in v1.
+   */
+  params: {};
+  result: {
+    /**
+     * All profiles known to the daemon.
+     */
+    profiles: Profile[];
+    /**
+     * Identifier of the currently active profile. Always references one of the profiles in the array.
+     */
+    active_profile_id: string;
+  };
+}
+/**
+ * A named set of bindings. The daemon keeps exactly one profile active at a time; switching profiles swaps the active binding set.
+ */
+export interface Profile {
+  /**
+   * Stable server-generated identifier for the profile.
+   */
+  id: string;
+  /**
+   * Human-friendly profile name.
+   */
+  name: string;
+  /**
+   * Bindings that belong to this profile.
+   */
+  bindings: Binding[];
+}
+/**
+ * Maps an input on a specific device to an action.
+ */
+export interface Binding {
+  device_id: DeviceID;
+  input_id: string;
+  trigger: InputAction;
+  action: Action;
+}
+/**
+ * An executable action bound to an input.
+ */
+export interface Action {
+  /**
+   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+   */
+  type: string;
+  /**
+   * Action-specific parameters. Schema depends on 'type'.
+   */
+  params?: {
+    [k: string]: unknown;
+  };
+}

package/src/methods/rename_profile.ts

@@ -0,0 +1,26 @@
+/* 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.
+ */
+
+/**
+ * Renames an existing profile. Does not affect its bindings or the active profile.
+ */
+export interface MethodRenameProfile {
+  params: {
+    /**
+     * Identifier of the profile to rename.
+     */
+    id: string;
+    /**
+     * New human-friendly name for the profile.
+     */
+    name: string;
+  };
+  /**
+   * Empty acknowledgement object. Reserved for future fields without breaking the schema.
+   */
+  result: {};
+}

package/src/methods/set_active_profile.ts

@@ -0,0 +1,24 @@
+/* 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.
+ */
+
+/**
+ * Sets which profile is active. The active profile is the one the binding editor reads and writes; switching it swaps the live binding set.
+ */
+export interface MethodSetActiveProfile {
+  params: {
+    /**
+     * Identifier of the profile to activate.
+     */
+    id: string;
+  };
+  result: {
+    /**
+     * Identifier of the now-active profile. Echoes the requested id on success.
+     */
+    active_profile_id: string;
+  };
+}

package/src/methods/set_auto_switch.ts

@@ -0,0 +1,45 @@
+/* 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.
+ */
+
+/**
+ * Replaces the entire auto-switch configuration in one shot (bulk set, not per-rule CRUD): the master toggle and the full rule set. The result echoes the persisted state.
+ */
+export interface MethodSetAutoSwitch {
+  params: {
+    /**
+     * Master toggle. When false, the daemon ignores the rules and never auto-switches.
+     */
+    enabled: boolean;
+    /**
+     * Full replacement set of app-to-profile rules. Any previously stored rules are discarded.
+     */
+    rules: AutoSwitchRule[];
+  };
+  result: {
+    /**
+     * Master toggle as persisted. Echoes the requested value on success.
+     */
+    enabled: boolean;
+    /**
+     * Rules as persisted. Echoes the requested set on success.
+     */
+    rules: AutoSwitchRule[];
+  };
+}
+/**
+ * Maps a foreground application to the profile that should become active while that app is frontmost. When the frontmost app matches no rule, the active profile is left unchanged (sticky behavior); there is no fallback profile.
+ */
+export interface AutoSwitchRule {
+  /**
+   * OS-native application identifier: bundle id on macOS, executable name on Linux/Windows. Opaque string, not portable across OSes; the daemon matches it verbatim against the frontmost app.
+   */
+  app: string;
+  /**
+   * Identifier of the profile to activate when this app is frontmost.
+   */
+  profile_id: string;
+}

package/src/methods/set_binding.ts

@@ -0,0 +1,52 @@
+/* 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;
+/**
+ * What happened on the input.
+ */
+export type InputAction = "press" | "release" | "rotate_cw" | "rotate_ccw" | "click";
+
+/**
+ * Creates or updates a binding (input -> action) on a device. The pair (device_id, input_id, trigger) is the unique key; calling this method with an existing key replaces the previous action.
+ */
+export interface MethodSetBinding {
+  params: {
+    binding: Binding;
+  };
+  /**
+   * Empty acknowledgement object. Reserved for future fields (e.g. server-assigned binding id) without breaking the schema.
+   */
+  result: {};
+}
+/**
+ * Maps an input on a specific device to an action.
+ */
+export interface Binding {
+  device_id: DeviceID;
+  input_id: string;
+  trigger: InputAction;
+  action: Action;
+}
+/**
+ * An executable action bound to an input.
+ */
+export interface Action {
+  /**
+   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+   */
+  type: string;
+  /**
+   * Action-specific parameters. Schema depends on 'type'.
+   */
+  params?: {
+    [k: string]: unknown;
+  };
+}