refactor: migrate to async isConfiguredAsync and remove deprecated tool-plugin import

This commit is contained in:
openclaw committed 2026-11-13 02:46:41 +00:00
1 parent 8cd50b1c4d
commit 59b7316944
13 files changed
+37 -61

No files matched your search

+2 -2
View File
@@ -15,7 +15,7 @@ export interface GeminiImagePluginConfig {
export declare function resolvePluginApiKey(rawKey: string | SecretRefObject | undefined): string | undefined; export declare function resolvePluginApiKey(rawKey: string | SecretRefObject | undefined): string | undefined;
export declare function resolveGeminiImageConfig(cfg: ImageGenerationRequest["cfg"] | undefined, apiPluginConfig?: Record<string, unknown>): GeminiImagePluginConfig | undefined; export declare function resolveGeminiImageConfig(cfg: ImageGenerationRequest["cfg"] | undefined, apiPluginConfig?: Record<string, unknown>): GeminiImagePluginConfig | undefined;
export declare function resolveConfiguredGeminiImageBaseUrl(pluginCfg?: GeminiImagePluginConfig): string; export declare function resolveConfiguredGeminiImageBaseUrl(pluginCfg?: GeminiImagePluginConfig): string;
export declare function buildGeminiImageGenerationProvider({ isProviderApiKeyConfigured, getPluginConfig, }: { export declare function buildGeminiImageGenerationProvider({ isProviderApiKeyConfiguredAsync, getPluginConfig, }: {
isProviderApiKeyConfigured: OpenClawPluginApi["runtime"]["modelAuth"]["isProviderApiKeyConfigured"]; isProviderApiKeyConfiguredAsync: OpenClawPluginApi["runtime"]["modelAuth"]["isProviderApiKeyConfiguredAsync"];
getPluginConfig?: () => Record<string, unknown> | undefined; getPluginConfig?: () => Record<string, unknown> | undefined;
}): ImageGenerationProvider; }): ImageGenerationProvider;
+3 -3
View File
@@ -25,13 +25,13 @@ export function resolveConfiguredGeminiImageBaseUrl(pluginCfg) {
normalizeOptionalString(process.env.GEMINI_IMAGE_BASE_URL) ?? normalizeOptionalString(process.env.GEMINI_IMAGE_BASE_URL) ??
DEFAULT_GEMINI_IMAGE_BASE_URL); DEFAULT_GEMINI_IMAGE_BASE_URL);
} }
export function buildGeminiImageGenerationProvider({ isProviderApiKeyConfigured, getPluginConfig, }) { export function buildGeminiImageGenerationProvider({ isProviderApiKeyConfiguredAsync, getPluginConfig, }) {
return { return {
id: "1h-gemini-image", id: "1h-gemini-image",
label: "1-h Gemini Image", label: "1-h Gemini Image",
defaultModel: DEFAULT_GEMINI_IMAGE_MODEL, defaultModel: DEFAULT_GEMINI_IMAGE_MODEL,
models: [DEFAULT_GEMINI_IMAGE_MODEL], models: [DEFAULT_GEMINI_IMAGE_MODEL],
isConfigured: (ctx) => { isConfiguredAsync: async (ctx) => {
const pluginCfg = resolveGeminiImageConfig(ctx.cfg, getPluginConfig?.()); const pluginCfg = resolveGeminiImageConfig(ctx.cfg, getPluginConfig?.());
if (resolvePluginApiKey(pluginCfg?.apiKey) || if (resolvePluginApiKey(pluginCfg?.apiKey) ||
Boolean(pluginCfg?.apiKey) || Boolean(pluginCfg?.apiKey) ||
@@ -40,7 +40,7 @@ export function buildGeminiImageGenerationProvider({ isProviderApiKeyConfigured,
normalizeOptionalString(process.env.BIFROST_API_KEY)) { normalizeOptionalString(process.env.BIFROST_API_KEY)) {
return true; return true;
} }
return isProviderApiKeyConfigured({ return await isProviderApiKeyConfiguredAsync({
provider: "google", provider: "google",
...ctx, ...ctx,
profileTypes: ["api_key"], profileTypes: ["api_key"],
+2 -2
View File
@@ -21,7 +21,7 @@ export declare function resolveImageSize(params: {
aspectRatio?: string; aspectRatio?: string;
model?: string; model?: string;
}): string; }): string;
export declare function buildOpenAIImageGenerationProvider({ isProviderApiKeyConfigured, getPluginConfig, }: { export declare function buildOpenAIImageGenerationProvider({ isProviderApiKeyConfiguredAsync, getPluginConfig, }: {
isProviderApiKeyConfigured: OpenClawPluginApi["runtime"]["modelAuth"]["isProviderApiKeyConfigured"]; isProviderApiKeyConfiguredAsync: OpenClawPluginApi["runtime"]["modelAuth"]["isProviderApiKeyConfiguredAsync"];
getPluginConfig?: () => Record<string, unknown> | undefined; getPluginConfig?: () => Record<string, unknown> | undefined;
}): ImageGenerationProvider; }): ImageGenerationProvider;
+3 -3
View File
@@ -76,13 +76,13 @@ export function resolveImageSize(params) {
return DEFAULT_SIZE; return DEFAULT_SIZE;
} }
} }
export function buildOpenAIImageGenerationProvider({ isProviderApiKeyConfigured, getPluginConfig, }) { export function buildOpenAIImageGenerationProvider({ isProviderApiKeyConfiguredAsync, getPluginConfig, }) {
return { return {
id: "1h-openai-image", id: "1h-openai-image",
label: "1-h OpenAI Image", label: "1-h OpenAI Image",
defaultModel: DEFAULT_OPENAI_IMAGE_MODEL, defaultModel: DEFAULT_OPENAI_IMAGE_MODEL,
models: [DEFAULT_OPENAI_IMAGE_MODEL, "gpt-image-2.5", "gpt-image-2.5-flare", "gpt-image-2.5-sunburst"], models: [DEFAULT_OPENAI_IMAGE_MODEL, "gpt-image-2.5", "gpt-image-2.5-flare", "gpt-image-2.5-sunburst"],
isConfigured: (ctx) => { isConfiguredAsync: async (ctx) => {
const pluginCfg = resolveImageConfig(ctx.cfg, getPluginConfig?.()); const pluginCfg = resolveImageConfig(ctx.cfg, getPluginConfig?.());
if (resolvePluginApiKey(pluginCfg?.apiKey) || if (resolvePluginApiKey(pluginCfg?.apiKey) ||
Boolean(pluginCfg?.apiKey) || Boolean(pluginCfg?.apiKey) ||
@@ -92,7 +92,7 @@ export function buildOpenAIImageGenerationProvider({ isProviderApiKeyConfigured,
normalizeOptionalString(process.env.OPENAI_API_KEY)) { normalizeOptionalString(process.env.OPENAI_API_KEY)) {
return true; return true;
} }
return isProviderApiKeyConfigured({ return await isProviderApiKeyConfiguredAsync({
provider: "openai", provider: "openai",
...ctx, ...ctx,
profileTypes: ["api_key"], profileTypes: ["api_key"],
+3 -13
View File
@@ -1,6 +1,5 @@
import { jsonResult } from "openclaw/plugin-sdk/core"; import { jsonResult } from "openclaw/plugin-sdk/core";
import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry"; import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
import { toolPluginMetadataSymbol } from "openclaw/plugin-sdk/tool-plugin";
import { echoTool } from "./tools/echo.js"; import { echoTool } from "./tools/echo.js";
import { buildOpenAIVideoGenerationProvider } from "./video/openai.js"; import { buildOpenAIVideoGenerationProvider } from "./video/openai.js";
import { buildOpenAIImageGenerationProvider } from "./image/openai.js"; import { buildOpenAIImageGenerationProvider } from "./image/openai.js";
@@ -23,28 +22,19 @@ const entry = definePluginEntry({
}); });
// 2. Register OpenAI-compatible video generation provider // 2. Register OpenAI-compatible video generation provider
api.registerVideoGenerationProvider(buildOpenAIVideoGenerationProvider({ api.registerVideoGenerationProvider(buildOpenAIVideoGenerationProvider({
isProviderApiKeyConfigured: api.runtime.modelAuth.isProviderApiKeyConfigured, isProviderApiKeyConfiguredAsync: api.runtime.modelAuth.isProviderApiKeyConfiguredAsync,
getPluginConfig: () => api.pluginConfig, getPluginConfig: () => api.pluginConfig,
})); }));
// 3. Register OpenAI-compatible image generation provider // 3. Register OpenAI-compatible image generation provider
api.registerImageGenerationProvider(buildOpenAIImageGenerationProvider({ api.registerImageGenerationProvider(buildOpenAIImageGenerationProvider({
isProviderApiKeyConfigured: api.runtime.modelAuth.isProviderApiKeyConfigured, isProviderApiKeyConfiguredAsync: api.runtime.modelAuth.isProviderApiKeyConfiguredAsync,
getPluginConfig: () => api.pluginConfig, getPluginConfig: () => api.pluginConfig,
})); }));
// 4. Register Gemini-native image generation provider // 4. Register Gemini-native image generation provider
api.registerImageGenerationProvider(buildGeminiImageGenerationProvider({ api.registerImageGenerationProvider(buildGeminiImageGenerationProvider({
isProviderApiKeyConfigured: api.runtime.modelAuth.isProviderApiKeyConfigured, isProviderApiKeyConfiguredAsync: api.runtime.modelAuth.isProviderApiKeyConfiguredAsync,
getPluginConfig: () => api.pluginConfig, getPluginConfig: () => api.pluginConfig,
})); }));
}, },
}); });
Object.defineProperty(entry, toolPluginMetadataSymbol, {
value: {
id: "1h-tools",
name: "1-h Tools",
description: "Custom Tools and Media Providers for OpenClaw.",
tools: [echoTool],
},
enumerable: false,
});
export default entry; export default entry;
+2 -2
View File
@@ -53,8 +53,8 @@ export declare function fetchOpenAIVideoDownload(params: {
deadline: ReturnType<typeof createProviderOperationDeadline>; deadline: ReturnType<typeof createProviderOperationDeadline>;
fetchFn: typeof fetch; fetchFn: typeof fetch;
} & OpenAIVideoRequestPolicy): Promise<any>; } & OpenAIVideoRequestPolicy): Promise<any>;
export declare function buildOpenAIVideoGenerationProvider({ isProviderApiKeyConfigured, getPluginConfig, }: { export declare function buildOpenAIVideoGenerationProvider({ isProviderApiKeyConfiguredAsync, getPluginConfig, }: {
isProviderApiKeyConfigured: OpenClawPluginApi["runtime"]["modelAuth"]["isProviderApiKeyConfigured"]; isProviderApiKeyConfiguredAsync: OpenClawPluginApi["runtime"]["modelAuth"]["isProviderApiKeyConfiguredAsync"];
getPluginConfig?: () => Record<string, unknown> | undefined; getPluginConfig?: () => Record<string, unknown> | undefined;
}): VideoGenerationProvider; }): VideoGenerationProvider;
export {}; export {};
+3 -3
View File
@@ -134,13 +134,13 @@ export async function fetchOpenAIVideoDownload(params) {
}, },
}); });
} }
export function buildOpenAIVideoGenerationProvider({ isProviderApiKeyConfigured, getPluginConfig, }) { export function buildOpenAIVideoGenerationProvider({ isProviderApiKeyConfiguredAsync, getPluginConfig, }) {
return { return {
id: "1h-openai-video", id: "1h-openai-video",
label: "1-h OpenAI Video", label: "1-h OpenAI Video",
defaultModel: DEFAULT_OPENAI_VIDEO_MODEL, defaultModel: DEFAULT_OPENAI_VIDEO_MODEL,
models: [DEFAULT_OPENAI_VIDEO_MODEL, "sora-2-pro", "gemini-video"], models: [DEFAULT_OPENAI_VIDEO_MODEL, "sora-2-pro", "gemini-video"],
isConfigured: (ctx) => { isConfiguredAsync: async (ctx) => {
const pluginCfg = resolveVideoConfig(ctx.cfg, getPluginConfig?.()); const pluginCfg = resolveVideoConfig(ctx.cfg, getPluginConfig?.());
if (resolvePluginApiKey(pluginCfg?.apiKey) || if (resolvePluginApiKey(pluginCfg?.apiKey) ||
Boolean(pluginCfg?.apiKey) || Boolean(pluginCfg?.apiKey) ||
@@ -149,7 +149,7 @@ export function buildOpenAIVideoGenerationProvider({ isProviderApiKeyConfigured,
normalizeOptionalString(process.env.CCLOAD_API_KEY)) { normalizeOptionalString(process.env.CCLOAD_API_KEY)) {
return true; return true;
} }
return isProviderApiKeyConfigured({ return await isProviderApiKeyConfiguredAsync({
provider: "openai", provider: "openai",
...ctx, ...ctx,
profileTypes: ["api_key"], profileTypes: ["api_key"],
+4 -4
View File
@@ -65,10 +65,10 @@ export function resolveConfiguredGeminiImageBaseUrl(
} }
export function buildGeminiImageGenerationProvider({ export function buildGeminiImageGenerationProvider({
isProviderApiKeyConfigured, isProviderApiKeyConfiguredAsync,
getPluginConfig, getPluginConfig,
}: { }: {
isProviderApiKeyConfigured: OpenClawPluginApi["runtime"]["modelAuth"]["isProviderApiKeyConfigured"]; isProviderApiKeyConfiguredAsync: OpenClawPluginApi["runtime"]["modelAuth"]["isProviderApiKeyConfiguredAsync"];
getPluginConfig?: () => Record<string, unknown> | undefined; getPluginConfig?: () => Record<string, unknown> | undefined;
}): ImageGenerationProvider { }): ImageGenerationProvider {
return { return {
@@ -76,7 +76,7 @@ export function buildGeminiImageGenerationProvider({
label: "1-h Gemini Image", label: "1-h Gemini Image",
defaultModel: DEFAULT_GEMINI_IMAGE_MODEL, defaultModel: DEFAULT_GEMINI_IMAGE_MODEL,
models: [DEFAULT_GEMINI_IMAGE_MODEL], models: [DEFAULT_GEMINI_IMAGE_MODEL],
isConfigured: (ctx) => { isConfiguredAsync: async (ctx) => {
const pluginCfg = resolveGeminiImageConfig(ctx.cfg, getPluginConfig?.()); const pluginCfg = resolveGeminiImageConfig(ctx.cfg, getPluginConfig?.());
if ( if (
resolvePluginApiKey(pluginCfg?.apiKey) || resolvePluginApiKey(pluginCfg?.apiKey) ||
@@ -87,7 +87,7 @@ export function buildGeminiImageGenerationProvider({
) { ) {
return true; return true;
} }
return isProviderApiKeyConfigured({ return await isProviderApiKeyConfiguredAsync({
provider: "google", provider: "google",
...ctx, ...ctx,
profileTypes: ["api_key"], profileTypes: ["api_key"],
+4 -4
View File
@@ -126,10 +126,10 @@ export function resolveImageSize(params: {
} }
export function buildOpenAIImageGenerationProvider({ export function buildOpenAIImageGenerationProvider({
isProviderApiKeyConfigured, isProviderApiKeyConfiguredAsync,
getPluginConfig, getPluginConfig,
}: { }: {
isProviderApiKeyConfigured: OpenClawPluginApi["runtime"]["modelAuth"]["isProviderApiKeyConfigured"]; isProviderApiKeyConfiguredAsync: OpenClawPluginApi["runtime"]["modelAuth"]["isProviderApiKeyConfiguredAsync"];
getPluginConfig?: () => Record<string, unknown> | undefined; getPluginConfig?: () => Record<string, unknown> | undefined;
}): ImageGenerationProvider { }): ImageGenerationProvider {
return { return {
@@ -137,7 +137,7 @@ export function buildOpenAIImageGenerationProvider({
label: "1-h OpenAI Image", label: "1-h OpenAI Image",
defaultModel: DEFAULT_OPENAI_IMAGE_MODEL, defaultModel: DEFAULT_OPENAI_IMAGE_MODEL,
models: [DEFAULT_OPENAI_IMAGE_MODEL, "gpt-image-2.5", "gpt-image-2.5-flare", "gpt-image-2.5-sunburst"], models: [DEFAULT_OPENAI_IMAGE_MODEL, "gpt-image-2.5", "gpt-image-2.5-flare", "gpt-image-2.5-sunburst"],
isConfigured: (ctx) => { isConfiguredAsync: async (ctx) => {
const pluginCfg = resolveImageConfig(ctx.cfg, getPluginConfig?.()); const pluginCfg = resolveImageConfig(ctx.cfg, getPluginConfig?.());
if ( if (
resolvePluginApiKey(pluginCfg?.apiKey) || resolvePluginApiKey(pluginCfg?.apiKey) ||
@@ -149,7 +149,7 @@ export function buildOpenAIImageGenerationProvider({
) { ) {
return true; return true;
} }
return isProviderApiKeyConfigured({ return await isProviderApiKeyConfiguredAsync({
provider: "openai", provider: "openai",
...ctx, ...ctx,
profileTypes: ["api_key"], profileTypes: ["api_key"],
+1 -6
View File
@@ -1,12 +1,7 @@
import { describe, expect, it, vi } from "vitest"; import { describe, expect, it, vi } from "vitest";
import entry from "./index.js"; import entry from "./index.js";
import { getToolPluginMetadata } from "openclaw/plugin-sdk/tool-plugin";
describe("1h-tools", () => { describe("1h-tools", () => {
it("declares tool metadata", () => {
expect(getToolPluginMetadata(entry)?.tools.map((tool) => tool.name)).toEqual(["echo"]);
});
it("registers tool, video provider, and both image providers", () => { it("registers tool, video provider, and both image providers", () => {
const registeredTools: unknown[] = []; const registeredTools: unknown[] = [];
const registeredVideoProviders: unknown[] = []; const registeredVideoProviders: unknown[] = [];
@@ -15,7 +10,7 @@ describe("1h-tools", () => {
const mockApi = { const mockApi = {
runtime: { runtime: {
modelAuth: { modelAuth: {
isProviderApiKeyConfigured: vi.fn().mockReturnValue(false), isProviderApiKeyConfiguredAsync: vi.fn().mockResolvedValue(false),
}, },
}, },
pluginConfig: {}, pluginConfig: {},
+3 -14
View File
@@ -1,6 +1,5 @@
import { jsonResult } from "openclaw/plugin-sdk/core"; import { jsonResult } from "openclaw/plugin-sdk/core";
import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry"; import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
import { toolPluginMetadataSymbol } from "openclaw/plugin-sdk/tool-plugin";
import { echoTool } from "./tools/echo.js"; import { echoTool } from "./tools/echo.js";
import { buildOpenAIVideoGenerationProvider } from "./video/openai.js"; import { buildOpenAIVideoGenerationProvider } from "./video/openai.js";
import { buildOpenAIImageGenerationProvider } from "./image/openai.js"; import { buildOpenAIImageGenerationProvider } from "./image/openai.js";
@@ -26,7 +25,7 @@ const entry = definePluginEntry({
// 2. Register OpenAI-compatible video generation provider // 2. Register OpenAI-compatible video generation provider
api.registerVideoGenerationProvider( api.registerVideoGenerationProvider(
buildOpenAIVideoGenerationProvider({ buildOpenAIVideoGenerationProvider({
isProviderApiKeyConfigured: api.runtime.modelAuth.isProviderApiKeyConfigured, isProviderApiKeyConfiguredAsync: api.runtime.modelAuth.isProviderApiKeyConfiguredAsync,
getPluginConfig: () => api.pluginConfig, getPluginConfig: () => api.pluginConfig,
}), }),
); );
@@ -34,7 +33,7 @@ const entry = definePluginEntry({
// 3. Register OpenAI-compatible image generation provider // 3. Register OpenAI-compatible image generation provider
api.registerImageGenerationProvider( api.registerImageGenerationProvider(
buildOpenAIImageGenerationProvider({ buildOpenAIImageGenerationProvider({
isProviderApiKeyConfigured: api.runtime.modelAuth.isProviderApiKeyConfigured, isProviderApiKeyConfiguredAsync: api.runtime.modelAuth.isProviderApiKeyConfiguredAsync,
getPluginConfig: () => api.pluginConfig, getPluginConfig: () => api.pluginConfig,
}), }),
); );
@@ -42,21 +41,11 @@ const entry = definePluginEntry({
// 4. Register Gemini-native image generation provider // 4. Register Gemini-native image generation provider
api.registerImageGenerationProvider( api.registerImageGenerationProvider(
buildGeminiImageGenerationProvider({ buildGeminiImageGenerationProvider({
isProviderApiKeyConfigured: api.runtime.modelAuth.isProviderApiKeyConfigured, isProviderApiKeyConfiguredAsync: api.runtime.modelAuth.isProviderApiKeyConfiguredAsync,
getPluginConfig: () => api.pluginConfig, getPluginConfig: () => api.pluginConfig,
}), }),
); );
}, },
}); });
Object.defineProperty(entry, toolPluginMetadataSymbol, {
value: {
id: "1h-tools",
name: "1-h Tools",
description: "Custom Tools and Media Providers for OpenClaw.",
tools: [echoTool],
},
enumerable: false,
});
export default entry; export default entry;
+3 -1
View File
@@ -9,7 +9,8 @@ declare module "openclaw/plugin-sdk/video-generation" {
label?: string; label?: string;
defaultModel?: string; defaultModel?: string;
models?: string[]; models?: string[];
isConfigured: (ctx: { cfg?: any }) => boolean; isConfigured?: (ctx: { cfg?: any }) => boolean;
isConfiguredAsync?: (ctx: { cfg?: any; agentDir?: string }) => Promise<boolean>;
capabilities: any; capabilities: any;
generateVideo: (req: VideoGenerationRequest) => Promise<any>; generateVideo: (req: VideoGenerationRequest) => Promise<any>;
} }
@@ -73,6 +74,7 @@ declare module "openclaw/plugin-sdk/image-generation" {
models?: string[]; models?: string[];
capabilities: any; capabilities: any;
isConfigured?: (ctx: { cfg?: any }) => boolean; isConfigured?: (ctx: { cfg?: any }) => boolean;
isConfiguredAsync?: (ctx: { cfg?: any; agentDir?: string }) => Promise<boolean>;
generateImage: (req: ImageGenerationRequest) => Promise<ImageGenerationResult>; generateImage: (req: ImageGenerationRequest) => Promise<ImageGenerationResult>;
} }
+4 -4
View File
@@ -239,10 +239,10 @@ export async function fetchOpenAIVideoDownload(
} }
export function buildOpenAIVideoGenerationProvider({ export function buildOpenAIVideoGenerationProvider({
isProviderApiKeyConfigured, isProviderApiKeyConfiguredAsync,
getPluginConfig, getPluginConfig,
}: { }: {
isProviderApiKeyConfigured: OpenClawPluginApi["runtime"]["modelAuth"]["isProviderApiKeyConfigured"]; isProviderApiKeyConfiguredAsync: OpenClawPluginApi["runtime"]["modelAuth"]["isProviderApiKeyConfiguredAsync"];
getPluginConfig?: () => Record<string, unknown> | undefined; getPluginConfig?: () => Record<string, unknown> | undefined;
}): VideoGenerationProvider { }): VideoGenerationProvider {
return { return {
@@ -250,7 +250,7 @@ export function buildOpenAIVideoGenerationProvider({
label: "1-h OpenAI Video", label: "1-h OpenAI Video",
defaultModel: DEFAULT_OPENAI_VIDEO_MODEL, defaultModel: DEFAULT_OPENAI_VIDEO_MODEL,
models: [DEFAULT_OPENAI_VIDEO_MODEL, "sora-2-pro", "gemini-video"], models: [DEFAULT_OPENAI_VIDEO_MODEL, "sora-2-pro", "gemini-video"],
isConfigured: (ctx) => { isConfiguredAsync: async (ctx) => {
const pluginCfg = resolveVideoConfig(ctx.cfg, getPluginConfig?.()); const pluginCfg = resolveVideoConfig(ctx.cfg, getPluginConfig?.());
if ( if (
resolvePluginApiKey(pluginCfg?.apiKey) || resolvePluginApiKey(pluginCfg?.apiKey) ||
@@ -261,7 +261,7 @@ export function buildOpenAIVideoGenerationProvider({
) { ) {
return true; return true;
} }
return isProviderApiKeyConfigured({ return await isProviderApiKeyConfiguredAsync({
provider: "openai", provider: "openai",
...ctx, ...ctx,
profileTypes: ["api_key"], profileTypes: ["api_key"],