@jdg-keyforge/protocol 0.6.0 → 0.8.0

package/dist/common.d.ts

@@ -61,12 +61,62 @@ export interface Action {
      */
     type: string;
     /**
-     * Action-specific parameters. Schema depends on 'type'.
+     * Action-specific parameters. Schema depends on 'type'. The daemon validates them against the per-type ActionParams definition (e.g. DelayActionParams for type 'delay').
      */
     params?: {
         [k: string]: unknown;
     };
 }
+/**
+ * Params for the built-in 'send_keys' action: types a key combination.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "SendKeysActionParams".
+ */
+export interface SendKeysActionParams {
+    /**
+     * Key combination to send, e.g. 'Ctrl+Shift+S'.
+     */
+    keys: string;
+}
+/**
+ * Params for the built-in 'launch_app' action: launches an application.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "LaunchAppActionParams".
+ */
+export interface LaunchAppActionParams {
+    /**
+     * Absolute path to the application or executable to launch.
+     */
+    path: string;
+}
+/**
+ * Params for the built-in 'delay' action: waits for the given duration. Mainly useful as a step inside a macro.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "DelayActionParams".
+ */
+export interface DelayActionParams {
+    /**
+     * Milliseconds to wait before continuing.
+     */
+    ms: number;
+}
+/**
+ * Params for the built-in 'macro' action: runs a sequence of actions in order. The schema allows any Action as a step; the daemon rejects nested macros (a step whose type is 'macro').
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "MacroActionParams".
+ */
+export interface MacroActionParams {
+    /**
+     * Actions to run in order. Must contain at least one step.
+     *
+     * @minItems 1
+     */
+    steps: [Action, ...Action[]];
+}
 /**
  * Maps an input on a specific device to an action.
  *
@@ -99,6 +149,30 @@ export interface Profile {
      */
     bindings: Binding[];
 }
+/**
+ * Portable, on-disk representation of a profile, written by export_profile and read by import_profile. Carries no server-local id: the id is meaningless outside the originating installation, so import always assigns a fresh one. The 'version' field lets readers detect and adapt to format changes.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "ExportedProfile".
+ */
+export interface ExportedProfile {
+    /**
+     * Magic marker identifying the file as a KeyForge profile export.
+     */
+    format: "keyforge.profile";
+    /**
+     * Export format version. Currently 1; bumped if the on-disk shape changes.
+     */
+    version: 1;
+    /**
+     * Human-friendly profile name.
+     */
+    name: string;
+    /**
+     * Bindings that belong to the exported profile.
+     */
+    bindings: Binding[];
+}
 /**
  * A single physical input exposed by a device (a key or an encoder).
  *

package/dist/index.d.ts

@@ -3,8 +3,10 @@ export * from './envelope.js';
 export type { MethodCreateProfile } from './methods/create_profile.js';
 export type { MethodDeleteProfile } from './methods/delete_profile.js';
 export type { MethodDuplicateProfile } from './methods/duplicate_profile.js';
+export type { MethodExportProfile } from './methods/export_profile.js';
 export type { MethodGetAutoSwitch } from './methods/get_auto_switch.js';
 export type { MethodHello } from './methods/hello.js';
+export type { MethodImportProfile } from './methods/import_profile.js';
 export type { MethodListActions } from './methods/list_actions.js';
 export type { MethodListBindings } from './methods/list_bindings.js';
 export type { MethodListDevices } from './methods/list_devices.js';

package/dist/methods/create_profile.d.ts

@@ -60,7 +60,7 @@ export interface Action {
      */
     type: string;
     /**
-     * Action-specific parameters. Schema depends on 'type'.
+     * Action-specific parameters. Schema depends on 'type'. The daemon validates them against the per-type ActionParams definition (e.g. DelayActionParams for type 'delay').
      */
     params?: {
         [k: string]: unknown;

package/dist/methods/duplicate_profile.d.ts

@@ -64,7 +64,7 @@ export interface Action {
      */
     type: string;
     /**
-     * Action-specific parameters. Schema depends on 'type'.
+     * Action-specific parameters. Schema depends on 'type'. The daemon validates them against the per-type ActionParams definition (e.g. DelayActionParams for type 'delay').
      */
     params?: {
         [k: string]: unknown;

package/dist/methods/export_profile.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+/**
+ * Serializes the profile identified by 'id' as a portable ExportedProfile document and writes it to 'path' on the daemon host's filesystem. The exported file omits the server-local id. Returns the path that was written.
+ */
+export interface MethodExportProfile {
+    params: {
+        /**
+         * Identifier of the profile to export.
+         */
+        id: string;
+        /**
+         * Filesystem path on the daemon host where the exported file is written.
+         */
+        path: string;
+    };
+    result: {
+        /**
+         * Echo of the path that was written.
+         */
+        path: string;
+    };
+}

package/dist/methods/export_profile.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/methods/import_profile.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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";
+/**
+ * Reads an ExportedProfile document from 'path' on the daemon host's filesystem, validates it, and creates a new profile from it. The server generates a fresh id; any id in the file is ignored. Does not change the active profile. Returns the created profile.
+ */
+export interface MethodImportProfile {
+    params: {
+        /**
+         * Filesystem path on the daemon host of the exported file to import.
+         */
+        path: string;
+    };
+    result: {
+        profile: Profile;
+    };
+}
+/**
+ * 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'. The daemon validates them against the per-type ActionParams definition (e.g. DelayActionParams for type 'delay').
+     */
+    params?: {
+        [k: string]: unknown;
+    };
+}

package/dist/methods/import_profile.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/methods/list_bindings.d.ts

@@ -44,7 +44,7 @@ export interface Action {
      */
     type: string;
     /**
-     * Action-specific parameters. Schema depends on 'type'.
+     * Action-specific parameters. Schema depends on 'type'. The daemon validates them against the per-type ActionParams definition (e.g. DelayActionParams for type 'delay').
      */
     params?: {
         [k: string]: unknown;

package/dist/methods/list_profiles.d.ts

@@ -65,7 +65,7 @@ export interface Action {
      */
     type: string;
     /**
-     * Action-specific parameters. Schema depends on 'type'.
+     * Action-specific parameters. Schema depends on 'type'. The daemon validates them against the per-type ActionParams definition (e.g. DelayActionParams for type 'delay').
      */
     params?: {
         [k: string]: unknown;

package/dist/methods/set_binding.d.ts

@@ -41,7 +41,7 @@ export interface Action {
      */
     type: string;
     /**
-     * Action-specific parameters. Schema depends on 'type'.
+     * Action-specific parameters. Schema depends on 'type'. The daemon validates them against the per-type ActionParams definition (e.g. DelayActionParams for type 'delay').
      */
     params?: {
         [k: string]: unknown;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jdg-keyforge/protocol",
-  "version": "0.6.0",
+  "version": "0.8.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

@@ -64,12 +64,62 @@ export interface Action {
    */
   type: string;
   /**
-   * Action-specific parameters. Schema depends on 'type'.
+   * Action-specific parameters. Schema depends on 'type'. The daemon validates them against the per-type ActionParams definition (e.g. DelayActionParams for type 'delay').
    */
   params?: {
     [k: string]: unknown;
   };
 }
+/**
+ * Params for the built-in 'send_keys' action: types a key combination.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "SendKeysActionParams".
+ */
+export interface SendKeysActionParams {
+  /**
+   * Key combination to send, e.g. 'Ctrl+Shift+S'.
+   */
+  keys: string;
+}
+/**
+ * Params for the built-in 'launch_app' action: launches an application.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "LaunchAppActionParams".
+ */
+export interface LaunchAppActionParams {
+  /**
+   * Absolute path to the application or executable to launch.
+   */
+  path: string;
+}
+/**
+ * Params for the built-in 'delay' action: waits for the given duration. Mainly useful as a step inside a macro.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "DelayActionParams".
+ */
+export interface DelayActionParams {
+  /**
+   * Milliseconds to wait before continuing.
+   */
+  ms: number;
+}
+/**
+ * Params for the built-in 'macro' action: runs a sequence of actions in order. The schema allows any Action as a step; the daemon rejects nested macros (a step whose type is 'macro').
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "MacroActionParams".
+ */
+export interface MacroActionParams {
+  /**
+   * Actions to run in order. Must contain at least one step.
+   *
+   * @minItems 1
+   */
+  steps: [Action, ...Action[]];
+}
 /**
  * Maps an input on a specific device to an action.
  *
@@ -102,6 +152,30 @@ export interface Profile {
    */
   bindings: Binding[];
 }
+/**
+ * Portable, on-disk representation of a profile, written by export_profile and read by import_profile. Carries no server-local id: the id is meaningless outside the originating installation, so import always assigns a fresh one. The 'version' field lets readers detect and adapt to format changes.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "ExportedProfile".
+ */
+export interface ExportedProfile {
+  /**
+   * Magic marker identifying the file as a KeyForge profile export.
+   */
+  format: "keyforge.profile";
+  /**
+   * Export format version. Currently 1; bumped if the on-disk shape changes.
+   */
+  version: 1;
+  /**
+   * Human-friendly profile name.
+   */
+  name: string;
+  /**
+   * Bindings that belong to the exported profile.
+   */
+  bindings: Binding[];
+}
 /**
  * A single physical input exposed by a device (a key or an encoder).
  *

package/src/index.ts

@@ -6,8 +6,10 @@ export * from './envelope.js';
 export type { MethodCreateProfile } from './methods/create_profile.js';
 export type { MethodDeleteProfile } from './methods/delete_profile.js';
 export type { MethodDuplicateProfile } from './methods/duplicate_profile.js';
+export type { MethodExportProfile } from './methods/export_profile.js';
 export type { MethodGetAutoSwitch } from './methods/get_auto_switch.js';
 export type { MethodHello } from './methods/hello.js';
+export type { MethodImportProfile } from './methods/import_profile.js';
 export type { MethodListActions } from './methods/list_actions.js';
 export type { MethodListBindings } from './methods/list_bindings.js';
 export type { MethodListDevices } from './methods/list_devices.js';

package/src/methods/create_profile.ts

@@ -63,7 +63,7 @@ export interface Action {
    */
   type: string;
   /**
-   * Action-specific parameters. Schema depends on 'type'.
+   * Action-specific parameters. Schema depends on 'type'. The daemon validates them against the per-type ActionParams definition (e.g. DelayActionParams for type 'delay').
    */
   params?: {
     [k: string]: unknown;

package/src/methods/duplicate_profile.ts

@@ -67,7 +67,7 @@ export interface Action {
    */
   type: string;
   /**
-   * Action-specific parameters. Schema depends on 'type'.
+   * Action-specific parameters. Schema depends on 'type'. The daemon validates them against the per-type ActionParams definition (e.g. DelayActionParams for type 'delay').
    */
   params?: {
     [k: string]: unknown;

package/src/methods/export_profile.ts

@@ -0,0 +1,28 @@
+/* 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.
+ */
+
+/**
+ * Serializes the profile identified by 'id' as a portable ExportedProfile document and writes it to 'path' on the daemon host's filesystem. The exported file omits the server-local id. Returns the path that was written.
+ */
+export interface MethodExportProfile {
+  params: {
+    /**
+     * Identifier of the profile to export.
+     */
+    id: string;
+    /**
+     * Filesystem path on the daemon host where the exported file is written.
+     */
+    path: string;
+  };
+  result: {
+    /**
+     * Echo of the path that was written.
+     */
+    path: string;
+  };
+}

package/src/methods/import_profile.ts

@@ -0,0 +1,71 @@
+/* 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";
+
+/**
+ * Reads an ExportedProfile document from 'path' on the daemon host's filesystem, validates it, and creates a new profile from it. The server generates a fresh id; any id in the file is ignored. Does not change the active profile. Returns the created profile.
+ */
+export interface MethodImportProfile {
+  params: {
+    /**
+     * Filesystem path on the daemon host of the exported file to import.
+     */
+    path: string;
+  };
+  result: {
+    profile: Profile;
+  };
+}
+/**
+ * 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'. The daemon validates them against the per-type ActionParams definition (e.g. DelayActionParams for type 'delay').
+   */
+  params?: {
+    [k: string]: unknown;
+  };
+}

package/src/methods/list_bindings.ts

@@ -47,7 +47,7 @@ export interface Action {
    */
   type: string;
   /**
-   * Action-specific parameters. Schema depends on 'type'.
+   * Action-specific parameters. Schema depends on 'type'. The daemon validates them against the per-type ActionParams definition (e.g. DelayActionParams for type 'delay').
    */
   params?: {
     [k: string]: unknown;

package/src/methods/list_profiles.ts

@@ -68,7 +68,7 @@ export interface Action {
    */
   type: string;
   /**
-   * Action-specific parameters. Schema depends on 'type'.
+   * Action-specific parameters. Schema depends on 'type'. The daemon validates them against the per-type ActionParams definition (e.g. DelayActionParams for type 'delay').
    */
   params?: {
     [k: string]: unknown;

package/src/methods/set_binding.ts

@@ -44,7 +44,7 @@ export interface Action {
    */
   type: string;
   /**
-   * Action-specific parameters. Schema depends on 'type'.
+   * Action-specific parameters. Schema depends on 'type'. The daemon validates them against the per-type ActionParams definition (e.g. DelayActionParams for type 'delay').
    */
   params?: {
     [k: string]: unknown;