@elizaos/plugin-commands 2.0.3-beta.2 → 2.0.3-beta.4

package/dist/src/types.d.ts

@@ -0,0 +1,175 @@
+/**
+ * Command system types
+ */
+import type { HandlerCallback, Memory } from "@elizaos/core";
+export type CommandScope = "text" | "native" | "both";
+export type CommandCategory = "session" | "options" | "status" | "management" | "media" | "tools" | "docks" | "skills";
+/**
+ * The surfaces a command is offered on. Omitted/undefined on a definition means
+ * "all surfaces" (the default). `serializeCommand(cmd, surface)` filters on this.
+ */
+export type CommandSurface = "gui" | "tui" | "discord" | "telegram";
+/**
+ * A live source a client resolves an argument's choices from at render time
+ * (the registry can't enumerate models/views/skills/providers statically). The
+ * definition tags the source; the client fetches the concrete values.
+ */
+export type CommandArgSource = "models" | "views" | "settings-sections" | "skills" | "providers";
+/**
+ * Client-only behaviors the in-app surfaces (GUI/TUI) run directly, with no
+ * agent round-trip and no remote surface. Connectors filter `client` targets
+ * out (a Discord/Telegram user has nothing to clear or full-screen).
+ */
+export type ClientCommandAction = "clear-chat" | "new-conversation" | "toggle-fullscreen" | "open-command-palette" | "show-commands" | "toggle-transcription";
+/**
+ * Where a command executes — the single discriminant every surface routes on:
+ *   - `agent`    → the command runs through the agent (a deterministic command
+ *                  action handles it; `action` names that handler when known).
+ *   - `navigate` → opens a destination in the Eliza app; `path` is the in-app
+ *                  deep link, `tab`/`viewId`/`section` are routing hints.
+ *   - `client`   → a GUI/TUI-only behavior with no remote surface.
+ */
+export type CommandTarget = {
+    kind: "agent";
+    action?: string;
+} | {
+    kind: "navigate";
+    path: string;
+    tab?: string;
+    viewId?: string;
+    section?: string;
+} | {
+    kind: "client";
+    clientAction: ClientCommandAction;
+};
+export interface CommandArgDefinition {
+    name: string;
+    description: string;
+    required?: boolean;
+    choices?: string[] | ((ctx: CommandArgChoiceContext) => string[]);
+    /**
+     * A live choice source the client resolves at render time. Carried through
+     * serialization so the client knows to fetch models/views/skills/etc. for
+     * this arg instead of relying on static `choices`.
+     */
+    dynamicChoices?: CommandArgSource;
+    captureRemaining?: boolean;
+}
+export interface CommandArgChoiceContext {
+    provider?: string;
+    model?: string;
+    config?: Record<string, unknown>;
+}
+export interface CommandDefinition {
+    key: string;
+    nativeName?: string;
+    description: string;
+    textAliases: string[];
+    scope: CommandScope;
+    category?: CommandCategory;
+    acceptsArgs?: boolean;
+    args?: CommandArgDefinition[];
+    argsParsing?: "none" | "positional";
+    requiresAuth?: boolean;
+    requiresElevated?: boolean;
+    enabled?: boolean;
+    /**
+     * Where this command executes. Omitted = `{ kind: "agent" }` (the default):
+     * a deterministic command action handles it through the agent. Navigation /
+     * client commands set this explicitly so every surface routes them the same.
+     */
+    target?: CommandTarget;
+    /**
+     * The surfaces this command is offered on. Omitted/undefined = all surfaces
+     * (the default). `serializeCommand(cmd, surface)` filters on this so the
+     * `?surface=` catalog query returns only what that surface should render.
+     */
+    surfaces?: CommandSurface[];
+    /** Optional icon hint (lucide name) for menu rendering. */
+    icon?: string;
+    /**
+     * View ids for which this command is *view-dependent*: it is only surfaced in
+     * the command catalog while one of these views is the active (foreground)
+     * surface. Omitted/undefined = globally available (the default). A non-empty
+     * list scopes the command to those views — e.g. a `/calendar add` command that
+     * only makes sense while the calendar view is open. (#8798)
+     */
+    views?: string[];
+}
+/**
+ * Wire-safe argument shape produced by `serializeCommand`. Mirrors the client
+ * (`@elizaos/ui` `SlashCommandArg`) and TUI (`SerializedCommandArg`) transport
+ * types so all three consume one shape with no fabricated fields.
+ */
+export interface SerializedCommandArg {
+    name: string;
+    description: string;
+    required?: boolean;
+    choices?: string[];
+    dynamicChoices?: CommandArgSource;
+    captureRemaining?: boolean;
+}
+/** Where a serialized catalog item came from — drives menu grouping/labels. */
+export type SerializedCommandSource = "builtin" | "custom-action" | "saved";
+/**
+ * The canonical wire shape served by `GET /api/commands` and consumed by the
+ * web composer (`SlashCommandCatalogItem`), the TUI autocomplete
+ * (`SerializedCommand`), and the connector bridges. This is the single contract
+ * the route projects — no field is fabricated at the HTTP boundary.
+ */
+export interface SerializedCommand {
+    key: string;
+    nativeName: string;
+    description: string;
+    textAliases: string[];
+    scope: CommandScope;
+    category?: CommandCategory;
+    acceptsArgs: boolean;
+    args: SerializedCommandArg[];
+    requiresAuth: boolean;
+    requiresElevated: boolean;
+    surfaces?: CommandSurface[];
+    target: CommandTarget;
+    icon?: string;
+    source: SerializedCommandSource;
+    /** View ids this command is scoped to (#8798); omitted when global. */
+    views?: string[];
+}
+export interface CommandContext {
+    senderId?: string;
+    senderName?: string;
+    isAuthorized: boolean;
+    isElevated: boolean;
+    channelId?: string;
+    roomId: string;
+    accountId?: string;
+    config?: Record<string, unknown>;
+    message?: Memory;
+    callback?: HandlerCallback;
+}
+export interface CommandResult {
+    handled: boolean;
+    reply?: string;
+    shouldContinue: boolean;
+    error?: string;
+}
+export interface ParsedCommand {
+    key: string;
+    canonical: string;
+    args: string[];
+    rawArgs?: string;
+}
+export interface CommandDetectionResult {
+    isCommand: boolean;
+    command?: ParsedCommand;
+}
+/**
+ * Resolved command with full context
+ */
+export interface ResolvedCommand {
+    definition: CommandDefinition;
+    parsed: ParsedCommand;
+    context: CommandContext;
+    message: Memory;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAE7D,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;AACtD,MAAM,MAAM,eAAe,GACxB,SAAS,GACT,SAAS,GACT,QAAQ,GACR,YAAY,GACZ,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,CAAC;AAEZ;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,KAAK,GAAG,SAAS,GAAG,UAAU,CAAC;AAEpE;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GACzB,QAAQ,GACR,OAAO,GACP,mBAAmB,GACnB,QAAQ,GACR,WAAW,CAAC;AAEf;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAC5B,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,sBAAsB,GACtB,eAAe,GACf,sBAAsB,CAAC;AAE1B;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GACtB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAClC;IACA,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,YAAY,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAEzD,MAAM,WAAW,oBAAoB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,uBAAuB,KAAK,MAAM,EAAE,CAAC,CAAC;IAClE;;;;OAIG;IACH,cAAc,CAAC,EAAE,gBAAgB,CAAC;IAClC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,uBAAuB;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,iBAAiB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,EAAE,YAAY,CAAC;IACpB,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,IAAI,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;IACpC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;IAC5B,2DAA2D;IAC3D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,cAAc,CAAC,EAAE,gBAAgB,CAAC;IAClC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,+EAA+E;AAC/E,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,eAAe,GAAG,OAAO,CAAC;AAE5E;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,EAAE,YAAY,CAAC;IACpB,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,WAAW,EAAE,OAAO,CAAC;IACrB,IAAI,EAAE,oBAAoB,EAAE,CAAC;IAC7B,YAAY,EAAE,OAAO,CAAC;IACtB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;IAC5B,MAAM,EAAE,aAAa,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,uBAAuB,CAAC;IAChC,uEAAuE;IACvE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,OAAO,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACtC,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,aAAa,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B,UAAU,EAAE,iBAAiB,CAAC;IAC9B,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,cAAc,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;CAChB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elizaos/plugin-commands",
-  "version": "2.0.3-beta.2",
+  "version": "2.0.3-beta.4",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -36,6 +36,7 @@
     }
   },
   "files": [
+    "registry-entry.json",
     "dist",
     "auto-enable.ts"
   ],
@@ -48,7 +49,7 @@
     }
   },
   "dependencies": {
-    "@elizaos/core": "2.0.3-beta.2"
+    "@elizaos/core": "2.0.3-beta.4"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.4.14",
@@ -113,5 +114,5 @@
       "node": "Default export (Node.js)"
     }
   },
-  "gitHead": "82fe0f44215954c2417328203f5bd6510985c1fc"
+  "gitHead": "f76f55793a0fb8d6b869dd8ddce03970de061e34"
 }

package/registry-entry.json

@@ -0,0 +1,63 @@
+{
+	"id": "commands",
+	"name": "Commands",
+	"description": "Chat command system for Eliza agents (/help, /status, /reset, etc.)",
+	"npmName": "@elizaos/plugin-commands",
+	"version": "2.0.0-beta.0",
+	"source": "bundled",
+	"tags": ["commands"],
+	"config": {
+		"COMMANDS_CONFIG_ENABLED": {
+			"type": "boolean",
+			"required": false,
+			"sensitive": false,
+			"default": "false",
+			"label": "Config Enabled",
+			"help": "Enable /config command",
+			"advanced": false
+		},
+		"COMMANDS_DEBUG_ENABLED": {
+			"type": "boolean",
+			"required": false,
+			"sensitive": false,
+			"default": "false",
+			"label": "Debug Enabled",
+			"help": "Enable /debug command",
+			"advanced": true
+		},
+		"COMMANDS_BASH_ENABLED": {
+			"type": "boolean",
+			"required": false,
+			"sensitive": false,
+			"default": "false",
+			"label": "Bash Enabled",
+			"help": "Enable /bash command (elevated)",
+			"advanced": false
+		},
+		"COMMANDS_RESTART_ENABLED": {
+			"type": "boolean",
+			"required": false,
+			"sensitive": false,
+			"default": "true",
+			"label": "Restart Enabled",
+			"help": "Enable /restart command",
+			"advanced": false
+		}
+	},
+	"render": {
+		"visible": true,
+		"pinTo": [],
+		"style": "card",
+		"icon": "Command",
+		"group": "automation",
+		"groupOrder": 9,
+		"actions": ["enable", "configure"]
+	},
+	"resources": {
+		"homepage": "https://github.com/elizaos/eliza#readme",
+		"repository": "https://github.com/elizaos/eliza"
+	},
+	"dependsOn": [],
+	"kind": "plugin",
+	"subtype": "automation"
+}