mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-13 09:10:42 +00:00
88 lines
3.2 KiB
TypeScript
88 lines
3.2 KiB
TypeScript
export type PluginEntryConfig = {
|
|
enabled?: boolean;
|
|
hooks?: {
|
|
/** Controls prompt mutation via before_prompt_build and prompt fields from legacy before_agent_start. */
|
|
allowPromptInjection?: boolean;
|
|
/**
|
|
* Controls access to raw conversation content from conversation hooks including
|
|
* before_agent_run, before_model_resolve, before_agent_reply, llm_input, llm_output,
|
|
* before_agent_finalize, and agent_end.
|
|
* Non-bundled plugins must opt in explicitly; bundled plugins stay allowed unless disabled.
|
|
*/
|
|
allowConversationAccess?: boolean;
|
|
/** Default timeout in milliseconds for this plugin's typed hooks. */
|
|
timeoutMs?: number;
|
|
/** Per typed-hook timeout overrides in milliseconds. */
|
|
timeouts?: Record<string, number>;
|
|
};
|
|
subagent?: {
|
|
/** Explicitly allow this plugin to request per-run provider/model overrides for subagent runs. */
|
|
allowModelOverride?: boolean;
|
|
/**
|
|
* Allowed override targets as canonical provider/model refs.
|
|
* Use "*" to explicitly allow any model for this plugin.
|
|
*/
|
|
allowedModels?: string[];
|
|
};
|
|
llm?: {
|
|
/** Explicitly allow this plugin to request a model override for api.runtime.llm.complete. */
|
|
allowModelOverride?: boolean;
|
|
/**
|
|
* Allowed completion model override targets as canonical provider/model refs.
|
|
* Use "*" to explicitly allow any model for this plugin.
|
|
*/
|
|
allowedModels?: string[];
|
|
/** Explicitly allow this plugin to run completions against a non-default agent id. */
|
|
allowAgentIdOverride?: boolean;
|
|
};
|
|
config?: Record<string, unknown>;
|
|
};
|
|
|
|
export type PluginSlotsConfig = {
|
|
/** Select which plugin owns the memory slot ("none" disables memory plugins). */
|
|
memory?: string;
|
|
/** Select which plugin owns the context-engine slot. */
|
|
contextEngine?: string;
|
|
};
|
|
|
|
export type PluginsLoadConfig = {
|
|
/** Additional plugin/extension paths to load. */
|
|
paths?: string[];
|
|
};
|
|
|
|
export type PluginInstallRecord = Omit<InstallRecordBase, "source"> & {
|
|
source: InstallRecordBase["source"] | "marketplace";
|
|
marketplaceName?: string;
|
|
marketplaceSource?: string;
|
|
marketplacePlugin?: string;
|
|
};
|
|
|
|
export type PluginsConfig = {
|
|
/** Enable or disable plugin loading. */
|
|
enabled?: boolean;
|
|
/** Optional plugin allowlist (plugin ids). */
|
|
allow?: string[];
|
|
/** Optional plugin denylist (plugin ids). */
|
|
deny?: string[];
|
|
/**
|
|
* Controls how bundled plugins participate in runtime provider discovery when
|
|
* `allow` is configured.
|
|
*
|
|
* - `"allowlist"` (default): bundled provider plugins are gated by `allow`
|
|
* and `entries.<id>.enabled` like third-party plugins.
|
|
* - `"compat"`: legacy mode for migrated configs; bundled provider plugins
|
|
* can be force-loaded regardless of the allowlist.
|
|
*/
|
|
bundledDiscovery?: "compat" | "allowlist";
|
|
load?: PluginsLoadConfig;
|
|
slots?: PluginSlotsConfig;
|
|
entries?: Record<string, PluginEntryConfig>;
|
|
/**
|
|
* Internal transient carrier for plugin install records during command flows.
|
|
* This is intentionally omitted from the config schema and must not be
|
|
* persisted to openclaw.json.
|
|
*/
|
|
installs?: Record<string, PluginInstallRecord>;
|
|
};
|
|
import type { InstallRecordBase } from "./types.installs.js";
|