@elizaos/agent 0.25.8 → 2.0.0-alpha.83

package/packages/agent/src/runtime/eliza.d.ts

@@ -0,0 +1,205 @@
+import { AgentRuntime, type Character, type LogEntry, type Plugin } from "@elizaos/core";
+import { type ElizaConfig } from "../config/config";
+import type { PluginInstallRecord } from "../config/types.eliza";
+import { CORE_PLUGINS, OPTIONAL_CORE_PLUGINS } from "./core-plugins";
+/** Shape we expect from a dynamically-imported plugin package. */
+interface PluginModuleShape {
+    default?: Plugin;
+    plugin?: Plugin;
+    [key: string]: Plugin | undefined;
+}
+export declare function configureLocalEmbeddingPlugin(_plugin: Plugin, config?: ElizaConfig): void;
+/**
+ * Best-effort runtime shutdown that also closes the database adapter.
+ *
+ * AgentRuntime.stop() only stops services. plugin-sql keeps a process-global
+ * PGlite manager, so restarts must close the adapter or the next runtime can
+ * silently reuse the same broken manager instance.
+ */
+export declare function shutdownRuntime(runtime: AgentRuntime | null | undefined, context: string): Promise<void>;
+/**
+ * Remove duplicate actions across an ordered list of plugins.
+ *
+ * When multiple plugins define an action with the same `name`, only the first
+ * occurrence is kept.  This prevents "Action already registered" warnings from
+ * elizaOS core.  The function mutates each plugin's `actions` array in-place.
+ */
+export declare function deduplicatePluginActions(plugins: Plugin[]): void;
+export { CORE_PLUGINS, OPTIONAL_CORE_PLUGINS };
+/** Maps Eliza channel names to plugin package names. */
+export declare const CHANNEL_PLUGIN_MAP: Readonly<Record<string, string>>;
+export declare function findRuntimePluginExport(mod: PluginModuleShape): Plugin | null;
+/**
+ * Collect the set of plugin package names that should be loaded
+ * based on config, environment variables, and feature flags.
+ */
+/** @internal Exported for testing. */
+export declare function collectPluginNames(config: ElizaConfig): Set<string>;
+/** Subdirectory under the Eliza state dir for drop-in custom plugins. */
+export declare const CUSTOM_PLUGINS_DIRNAME = "plugins/custom";
+/** Subdirectory under the Eliza state dir for ejected plugins. */
+export declare const EJECTED_PLUGINS_DIRNAME = "plugins/ejected";
+/**
+ * Scan a directory for drop-in plugin packages. Each immediate subdirectory
+ * is treated as a plugin; name comes from package.json or the directory name.
+ */
+export declare function scanDropInPlugins(dir: string): Promise<Record<string, PluginInstallRecord>>;
+/**
+ * Merge drop-in plugins into the load set. Filters out denied, core-colliding,
+ * and already-installed names. Mutates `pluginsToLoad` and `installRecords`.
+ */
+export declare function mergeDropInPlugins(params: {
+    dropInRecords: Record<string, PluginInstallRecord>;
+    installRecords: Record<string, PluginInstallRecord>;
+    corePluginNames: ReadonlySet<string>;
+    denyList: ReadonlySet<string>;
+    pluginsToLoad: Set<string>;
+}): {
+    accepted: string[];
+    skipped: string[];
+};
+export declare function resolveElizaPluginImportSpecifier(pluginName: string, runtimeModuleUrl?: string): string;
+export declare function shouldIgnoreMissingPluginExport(pluginName: string): boolean;
+/**
+ * The `@elizaos/plugin-browser` npm package expects a `dist/server/` directory
+ * containing the compiled stagehand-server, but the npm publish doesn't include
+ * it.  The actual source/build lives in the workspace at
+ * `plugins/plugin-browser/stagehand-server/`.
+ *
+ * This function checks whether the server is reachable from the installed
+ * package and, if not, creates a symlink so the plugin's process-manager can
+ * find it.  Returns `true` when the server index.js is available (or was made
+ * available via symlink), `false` otherwise.
+ */
+/**
+ * Returns true if the given env var key is safe to forward to runtime.settings.
+ * Blocks blockchain private keys, secrets, passwords, tokens, credentials,
+ * mnemonics, and seed phrases while allowing API keys that plugins need.
+ */
+export declare function isEnvKeyAllowedForForwarding(key: string): boolean;
+export declare function ensureBrowserServerLink(): boolean;
+/** @internal Exported for testing. */
+export declare function repairBrokenInstallRecord(config: ElizaConfig, pluginName: string): boolean;
+/** Read package.json exports/main to find the importable entry file. */
+/** @internal Exported for testing. */
+export declare function resolvePackageEntry(pkgRoot: string): Promise<string>;
+/**
+ * Propagate channel credentials from Eliza config into process.env so
+ * that elizaOS plugins can find them.
+ */
+/** @internal Exported for testing. */
+export declare function applyConnectorSecretsToEnv(config: ElizaConfig): void;
+/**
+ * Auto-resolve Discord Application ID from the bot token via Discord API.
+ * Called during async runtime init so that users only need a bot token.
+ */
+/** @internal Exported for testing. */
+export declare function autoResolveDiscordAppId(): Promise<void>;
+/**
+ * Propagate cloud config from Eliza config into process.env so the
+ * ElizaCloud plugin can discover settings at startup.
+ */
+/** @internal Exported for testing. */
+export declare function applyCloudConfigToEnv(config: ElizaConfig): void;
+/**
+ * Translate `config.database` into the environment variables that
+ * `@elizaos/plugin-sql` reads at init time (`POSTGRES_URL`, `PGLITE_DATA_DIR`).
+ *
+ * When the provider is "postgres", we build a connection string from the
+ * credentials (or use the explicit `connectionString` field) and set
+ * `POSTGRES_URL`. When the provider is "pglite" (the default), we set
+ * `PGLITE_DATA_DIR` to either the configured value or a stable workspace
+ * default (`~/.eliza/workspace/.eliza/.elizadb`) and remove any stale
+ * `POSTGRES_URL`.
+ */
+/** @internal Exported for testing. */
+export declare function applyX402ConfigToEnv(config: ElizaConfig): void;
+/** @internal Exported for testing. */
+export declare function applyDatabaseConfigToEnv(config: ElizaConfig): void;
+type PgliteRecoveryAction = "none" | "retry-without-reset" | "reset-data-dir" | "fail-active-lock";
+/**
+ * Check for and remove a stale postmaster.pid in the PGlite data directory.
+ * The pid file is stale if the recorded process is no longer running.
+ */
+export declare function cleanStalePglitePid(dataDir: string): void;
+/** @internal Exported for testing. */
+export declare function isRecoverablePgliteInitError(err: unknown): boolean;
+/** @internal Exported for testing. */
+export declare function getPgliteRecoveryAction(err: unknown, dataDir: string): PgliteRecoveryAction;
+export declare function installRuntimeMethodBindings(runtime: AgentRuntime): void;
+/**
+ * Build an elizaOS Character from the Eliza config.
+ *
+ * Resolves the agent name from `config.agents.list` (first entry) or
+ * `config.ui.assistant.name`, falling back to "Eliza".  Character
+ * personality data (bio, system prompt, style, etc.) is stored in the
+ * database — not the config file — so we only provide sensible defaults
+ * here for the initial bootstrap.
+ */
+/** @internal Exported for testing. */
+export declare function buildCharacterFromConfig(config: ElizaConfig): Character;
+/**
+ * Resolve the primary model identifier from Eliza config.
+ *
+ * Eliza stores the model under `agents.defaults.model.primary` as an
+ * AgentModelListConfig object. Returns undefined when no model is
+ * explicitly configured (elizaOS falls back to whichever model
+ * plugin is loaded).
+ */
+/** @internal Exported for testing. */
+export declare function resolvePrimaryModel(config: ElizaConfig): string | undefined;
+/**
+ * Vision is a heavy optional plugin. When Eliza enables it, keep the service
+ * loaded but idle until the user explicitly selects CAMERA, SCREEN, or BOTH.
+ * This avoids background capture loops during normal app startup.
+ */
+export declare function resolveVisionModeSetting(config: ElizaConfig, env?: NodeJS.ProcessEnv): string | undefined;
+/** Options accepted by {@link startEliza}. */
+export interface StartElizaOptions {
+    /**
+     * When true, skip the interactive CLI chat loop and return the
+     * initialised {@link AgentRuntime} so it can be wired into the API
+     * server (used by `dev-server.ts`).
+     */
+    headless?: boolean;
+    /**
+     * When true, start the API server and keep running without entering
+     * the interactive chat loop. Used by `bun run start` for production
+     * server mode (like dev but without watch).
+     */
+    serverOnly?: boolean;
+    /**
+     * Internal guard to prevent infinite retry loops when recovering from
+     * corrupt PGLite state.
+     */
+    pgliteRecoveryAttempted?: boolean;
+}
+export interface BootElizaRuntimeOptions {
+    /**
+     * When true, require an existing ~/.eliza/eliza.json config file.
+     * This is used by non-CLI UIs (like the @elizaos/tui interface) where interactive
+     * onboarding prompts would break the alternate screen.
+     */
+    requireConfig?: boolean;
+}
+/**
+ * Boot the elizaOS runtime without starting the readline chat loop.
+ *
+ * This is a convenience wrapper around {@link startEliza} in headless mode,
+ * with optional config guards.
+ */
+export declare function bootElizaRuntime(opts?: BootElizaRuntimeOptions): Promise<AgentRuntime>;
+export declare const logToChatListener: (entry: LogEntry) => void;
+/**
+ * Start the elizaOS runtime with Eliza's configuration.
+ *
+ * In headless mode the runtime is returned instead of entering the
+ * interactive readline loop.
+ */
+export declare function startEliza(opts?: StartElizaOptions): Promise<AgentRuntime | undefined>;
+/**
+ * Start in cloud mode — connect to a remote cloud agent via the thin client.
+ * Skips all local runtime construction (plugins, database, etc.).
+ */
+export declare function startInCloudMode(config: ElizaConfig, agentId: string, opts?: StartElizaOptions): Promise<AgentRuntime | undefined>;
+//# sourceMappingURL=eliza.d.ts.map

package/packages/agent/src/runtime/eliza.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eliza.d.ts","sourceRoot":"","sources":["../../../../../src/runtime/eliza.ts"],"names":[],"mappings":"AAoCA,OAAO,EACL,YAAY,EAIZ,KAAK,SAAS,EAId,KAAK,QAAQ,EAIb,KAAK,MAAM,EAKZ,MAAM,eAAe,CAAC;AA0BvB,OAAO,EAEL,KAAK,WAAW,EAGjB,MAAM,kBAAkB,CAAC;AAQ1B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAcjE,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AA8FrE,kEAAkE;AAClE,UAAU,iBAAiB;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACnC;AAED,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,WAAW,GACnB,IAAI,CAwGN;AAeD;;;;;;GAMG;AACH,wBAAsB,eAAe,CACnC,OAAO,EAAE,YAAY,GAAG,IAAI,GAAG,SAAS,EACxC,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC,CA6Bf;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAgBhE;AAuLD,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,CAAC;AAa/C,wDAAwD;AACxD,eAAO,MAAM,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAsB/D,CAAC;AAqFF,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,iBAAiB,GAAG,MAAM,GAAG,IAAI,CAsC7E;AAED;;;GAGG;AACH,sCAAsC;AACtC,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,CA2RnE;AAMD,yEAAyE;AACzE,eAAO,MAAM,sBAAsB,mBAAmB,CAAC;AACvD,kEAAkE;AAClE,eAAO,MAAM,uBAAuB,oBAAoB,CAAC;AAEzD;;;GAGG;AACH,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CA2C9C;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE;IACzC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACnD,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACpD,eAAe,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IACrC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC9B,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAC5B,GAAG;IAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,CAyB5C;AA4CD,wBAAgB,iCAAiC,CAC/C,UAAU,EAAE,MAAM,EAClB,gBAAgB,SAAkB,GACjC,MAAM,CAaR;AAED,wBAAgB,+BAA+B,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAE3E;AAUD;;;;;;;;;;GAUG;AACH;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAWjE;AAED,wBAAgB,uBAAuB,IAAI,OAAO,CA2EjD;AAkTD,sCAAsC;AACtC,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,MAAM,GACjB,OAAO,CAST;AAuGD,wEAAwE;AACxE,sCAAsC;AACtC,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA8D1E;AAMD;;;GAGG;AACH,sCAAsC;AACtC,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAuCpE;AAED;;;GAGG;AACH,sCAAsC;AACtC,wBAAsB,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC,CA8B7D;AAED;;;GAGG;AACH,sCAAsC;AACtC,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAiG/D;AAED;;;;;;;;;;GAUG;AACH,sCAAsC;AACtC,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAU9D;AAQD,sCAAsC;AACtC,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAoDlE;AAUD,KAAK,oBAAoB,GACrB,MAAM,GACN,qBAAqB,GACrB,gBAAgB,GAChB,kBAAkB,CAAC;AAoDvB;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAEzD;AAoDD,sCAAsC;AACtC,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CA0BlE;AAED,sCAAsC;AACtC,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,OAAO,EACZ,OAAO,EAAE,MAAM,GACd,oBAAoB,CAgBtB;AAqPD,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI,CA2NxE;AAoGD;;;;;;;;GAQG;AACH,sCAAsC;AACtC,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,CAmJvE;AAED;;;;;;;GAOG;AACH,sCAAsC;AACtC,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,CAM3E;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,WAAW,EACnB,GAAG,GAAE,MAAM,CAAC,UAAwB,GACnC,MAAM,GAAG,SAAS,CAKpB;AAsiBD,8CAA8C;AAC9C,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,GAAE,uBAA4B,GACjC,OAAO,CAAC,YAAY,CAAC,CAYvB;AAcD,eAAO,MAAM,iBAAiB,GAAI,OAAO,QAAQ,SAgChD,CAAC;AAEF;;;;;GAKG;AACH,wBAAsB,UAAU,CAC9B,IAAI,CAAC,EAAE,iBAAiB,GACvB,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CA6nCnC;AASD;;;GAGG;AACH,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,WAAW,EACnB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,iBAAiB,GACvB,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CA0FnC"}