@jdg-keyforge/protocol 0.8.0 → 0.9.0

package/dist/common.d.ts

@@ -57,7 +57,7 @@ export interface InputEvent {
  */
 export interface Action {
     /**
-     * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+     * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'. Plugin ids are reverse-DNS (they contain dots) and action ids never do, so the action id is everything after the last dot.
      */
     type: string;
     /**
@@ -243,3 +243,136 @@ export interface AutoSwitchRule {
      */
     profile_id: string;
 }
+/**
+ * Describes one action parameter so a client can render an input for it.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "ParamSpec".
+ */
+export interface ParamSpec {
+    /**
+     * Param key written into Action.params. Unique within the action.
+     */
+    name: string;
+    /**
+     * Human-friendly field label.
+     */
+    label: string;
+    /**
+     * Param value type. Only 'string' in v1.
+     */
+    type: "string";
+    required: boolean;
+    /**
+     * Optional placeholder/example shown in the input.
+     */
+    placeholder?: string;
+}
+/**
+ * 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.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "PluginManifest".
+ */
+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;
+    /**
+     * Human-friendly plugin name for the UI.
+     */
+    name: string;
+    /**
+     * Plugin version (SemVer 2.0).
+     */
+    version: string;
+    /**
+     * Major version of the protocol the plugin speaks. Lets the daemon reject an incompatible plugin before spawning it. Currently '1'.
+     */
+    protocol_version: "1";
+    /**
+     * Plugin author, shown in the UI.
+     */
+    author?: string;
+    /**
+     * Short description of what the plugin does.
+     */
+    description?: string;
+    /**
+     * URL of the plugin homepage or source repository.
+     */
+    homepage?: string;
+    /**
+     * Category the UI groups the plugin's actions under (e.g. 'Audio', 'Streaming').
+     */
+    category?: string;
+    /**
+     * Path to the plugin icon, relative to the plugin root. No leading '/', no '\' and no ':'.
+     */
+    icon?: string;
+    /**
+     * Command the daemon runs to start the plugin, per OS (keys match Go's GOOS). The plugin supports exactly the OSes listed here.
+     */
+    entrypoint: {
+        darwin?: PluginCommand;
+        linux?: PluginCommand;
+        windows?: PluginCommand;
+    };
+    /**
+     * Actions the plugin exposes. Each becomes bindable as 'plugin.<id>.<action id>'.
+     *
+     * @minItems 1
+     */
+    actions: [PluginAction, ...PluginAction[]];
+}
+/**
+ * Executable plus arguments used to start a plugin process.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "PluginCommand".
+ */
+export interface PluginCommand {
+    /**
+     * Executable to run. A path containing '/' is resolved relative to the plugin root; a bare name (e.g. 'node') is looked up on the PATH. Always use '/' as separator, also on Windows; absolute paths, '\' and ':' are not allowed.
+     */
+    path: string;
+    /**
+     * Arguments passed to the executable.
+     */
+    args?: string[];
+}
+/**
+ * An action a plugin exposes, declared in its manifest.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "PluginAction".
+ */
+export interface PluginAction {
+    /**
+     * Action identifier, unique within the plugin. snake_case, no dots.
+     */
+    id: string;
+    /**
+     * Human-friendly action name for the UI.
+     */
+    name: string;
+    /**
+     * Optional longer description of what the action does.
+     */
+    description?: string;
+    /**
+     * Input kinds the action can be bound to. Omitted means any kind.
+     *
+     * @minItems 1
+     */
+    inputs?: [InputKind, ...InputKind[]];
+    /**
+     * Params this action accepts, in display order.
+     */
+    params: ParamSpec[];
+}

package/dist/methods/create_profile.d.ts

@@ -56,7 +56,7 @@ export interface Binding {
  */
 export interface Action {
     /**
-     * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+     * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'. Plugin ids are reverse-DNS (they contain dots) and action ids never do, so the action id is everything after the last dot.
      */
     type: string;
     /**

package/dist/methods/duplicate_profile.d.ts

@@ -60,7 +60,7 @@ export interface Binding {
  */
 export interface Action {
     /**
-     * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+     * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'. Plugin ids are reverse-DNS (they contain dots) and action ids never do, so the action id is everything after the last dot.
      */
     type: string;
     /**

package/dist/methods/import_profile.d.ts

@@ -56,7 +56,7 @@ export interface Binding {
  */
 export interface Action {
     /**
-     * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+     * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'. Plugin ids are reverse-DNS (they contain dots) and action ids never do, so the action id is everything after the last dot.
      */
     type: string;
     /**

package/dist/methods/list_actions.d.ts

@@ -44,13 +44,10 @@ export interface ActionDescriptor {
 }
 /**
  * Describes one action parameter so a client can render an input for it.
- *
- * This interface was referenced by `MethodListActions`'s JSON-Schema
- * via the `definition` "ParamSpec".
  */
 export interface ParamSpec {
     /**
-     * Param key written into Action.params.
+     * Param key written into Action.params. Unique within the action.
      */
     name: string;
     /**

package/dist/methods/list_bindings.d.ts

@@ -40,7 +40,7 @@ export interface Binding {
  */
 export interface Action {
     /**
-     * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+     * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'. Plugin ids are reverse-DNS (they contain dots) and action ids never do, so the action id is everything after the last dot.
      */
     type: string;
     /**

package/dist/methods/list_profiles.d.ts

@@ -61,7 +61,7 @@ export interface Binding {
  */
 export interface Action {
     /**
-     * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+     * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'. Plugin ids are reverse-DNS (they contain dots) and action ids never do, so the action id is everything after the last dot.
      */
     type: string;
     /**

package/dist/methods/set_binding.d.ts

@@ -37,7 +37,7 @@ export interface Binding {
  */
 export interface Action {
     /**
-     * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+     * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'. Plugin ids are reverse-DNS (they contain dots) and action ids never do, so the action id is everything after the last dot.
      */
     type: string;
     /**

package/package.json

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

@@ -60,7 +60,7 @@ export interface InputEvent {
  */
 export interface Action {
   /**
-   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'. Plugin ids are reverse-DNS (they contain dots) and action ids never do, so the action id is everything after the last dot.
    */
   type: string;
   /**
@@ -246,3 +246,136 @@ export interface AutoSwitchRule {
    */
   profile_id: string;
 }
+/**
+ * Describes one action parameter so a client can render an input for it.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "ParamSpec".
+ */
+export interface ParamSpec {
+  /**
+   * Param key written into Action.params. Unique within the action.
+   */
+  name: string;
+  /**
+   * Human-friendly field label.
+   */
+  label: string;
+  /**
+   * Param value type. Only 'string' in v1.
+   */
+  type: "string";
+  required: boolean;
+  /**
+   * Optional placeholder/example shown in the input.
+   */
+  placeholder?: string;
+}
+/**
+ * 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.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "PluginManifest".
+ */
+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;
+  /**
+   * Human-friendly plugin name for the UI.
+   */
+  name: string;
+  /**
+   * Plugin version (SemVer 2.0).
+   */
+  version: string;
+  /**
+   * Major version of the protocol the plugin speaks. Lets the daemon reject an incompatible plugin before spawning it. Currently '1'.
+   */
+  protocol_version: "1";
+  /**
+   * Plugin author, shown in the UI.
+   */
+  author?: string;
+  /**
+   * Short description of what the plugin does.
+   */
+  description?: string;
+  /**
+   * URL of the plugin homepage or source repository.
+   */
+  homepage?: string;
+  /**
+   * Category the UI groups the plugin's actions under (e.g. 'Audio', 'Streaming').
+   */
+  category?: string;
+  /**
+   * Path to the plugin icon, relative to the plugin root. No leading '/', no '\' and no ':'.
+   */
+  icon?: string;
+  /**
+   * Command the daemon runs to start the plugin, per OS (keys match Go's GOOS). The plugin supports exactly the OSes listed here.
+   */
+  entrypoint: {
+    darwin?: PluginCommand;
+    linux?: PluginCommand;
+    windows?: PluginCommand;
+  };
+  /**
+   * Actions the plugin exposes. Each becomes bindable as 'plugin.<id>.<action id>'.
+   *
+   * @minItems 1
+   */
+  actions: [PluginAction, ...PluginAction[]];
+}
+/**
+ * Executable plus arguments used to start a plugin process.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "PluginCommand".
+ */
+export interface PluginCommand {
+  /**
+   * Executable to run. A path containing '/' is resolved relative to the plugin root; a bare name (e.g. 'node') is looked up on the PATH. Always use '/' as separator, also on Windows; absolute paths, '\' and ':' are not allowed.
+   */
+  path: string;
+  /**
+   * Arguments passed to the executable.
+   */
+  args?: string[];
+}
+/**
+ * An action a plugin exposes, declared in its manifest.
+ *
+ * This interface was referenced by `CommonTypes`'s JSON-Schema
+ * via the `definition` "PluginAction".
+ */
+export interface PluginAction {
+  /**
+   * Action identifier, unique within the plugin. snake_case, no dots.
+   */
+  id: string;
+  /**
+   * Human-friendly action name for the UI.
+   */
+  name: string;
+  /**
+   * Optional longer description of what the action does.
+   */
+  description?: string;
+  /**
+   * Input kinds the action can be bound to. Omitted means any kind.
+   *
+   * @minItems 1
+   */
+  inputs?: [InputKind, ...InputKind[]];
+  /**
+   * Params this action accepts, in display order.
+   */
+  params: ParamSpec[];
+}

package/src/methods/create_profile.ts

@@ -59,7 +59,7 @@ export interface Binding {
  */
 export interface Action {
   /**
-   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'. Plugin ids are reverse-DNS (they contain dots) and action ids never do, so the action id is everything after the last dot.
    */
   type: string;
   /**

package/src/methods/duplicate_profile.ts

@@ -63,7 +63,7 @@ export interface Binding {
  */
 export interface Action {
   /**
-   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'. Plugin ids are reverse-DNS (they contain dots) and action ids never do, so the action id is everything after the last dot.
    */
   type: string;
   /**

package/src/methods/import_profile.ts

@@ -59,7 +59,7 @@ export interface Binding {
  */
 export interface Action {
   /**
-   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'. Plugin ids are reverse-DNS (they contain dots) and action ids never do, so the action id is everything after the last dot.
    */
   type: string;
   /**

package/src/methods/list_actions.ts

@@ -46,13 +46,10 @@ export interface ActionDescriptor {
 }
 /**
  * Describes one action parameter so a client can render an input for it.
- *
- * This interface was referenced by `MethodListActions`'s JSON-Schema
- * via the `definition` "ParamSpec".
  */
 export interface ParamSpec {
   /**
-   * Param key written into Action.params.
+   * Param key written into Action.params. Unique within the action.
    */
   name: string;
   /**

package/src/methods/list_bindings.ts

@@ -43,7 +43,7 @@ export interface Binding {
  */
 export interface Action {
   /**
-   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'. Plugin ids are reverse-DNS (they contain dots) and action ids never do, so the action id is everything after the last dot.
    */
   type: string;
   /**

package/src/methods/list_profiles.ts

@@ -64,7 +64,7 @@ export interface Binding {
  */
 export interface Action {
   /**
-   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'. Plugin ids are reverse-DNS (they contain dots) and action ids never do, so the action id is everything after the last dot.
    */
   type: string;
   /**

package/src/methods/set_binding.ts

@@ -40,7 +40,7 @@ export interface Binding {
  */
 export interface Action {
   /**
-   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'.
+   * Action type. Built-ins are well-known; plugin actions use 'plugin.<plugin_id>.<action_id>'. Plugin ids are reverse-DNS (they contain dots) and action ids never do, so the action id is everything after the last dot.
    */
   type: string;
   /**