Vendor OpenClaw source as Adolf fork baseline
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11), free to diverge. Tree copied sans upstream .git; upstream remote added for future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19. Preserves docs/ARCHITECTURE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
This commit is contained in:
11
extensions/huggingface/api.ts
Normal file
11
extensions/huggingface/api.ts
Normal file
@@ -0,0 +1,11 @@
|
||||
// Huggingface API module exposes the plugin public contract.
|
||||
export {
|
||||
buildHuggingfaceModelDefinition,
|
||||
discoverHuggingfaceModels,
|
||||
HUGGINGFACE_BASE_URL,
|
||||
HUGGINGFACE_MODEL_CATALOG,
|
||||
HUGGINGFACE_POLICY_SUFFIXES,
|
||||
isHuggingfacePolicyLocked,
|
||||
} from "./models.js";
|
||||
export { buildHuggingfaceProvider } from "./provider-catalog.js";
|
||||
export { applyHuggingfaceConfig, HUGGINGFACE_DEFAULT_MODEL_REF } from "./onboard.js";
|
||||
82
extensions/huggingface/index.test.ts
Normal file
82
extensions/huggingface/index.test.ts
Normal file
@@ -0,0 +1,82 @@
|
||||
// Huggingface tests cover index plugin behavior.
|
||||
import { createTestPluginApi } from "openclaw/plugin-sdk/plugin-test-api";
|
||||
import { afterAll, describe, expect, it, vi } from "vitest";
|
||||
|
||||
const buildHuggingfaceProviderMock = vi.hoisted(() =>
|
||||
vi.fn(async () => ({
|
||||
baseUrl: "https://router.huggingface.co/v1",
|
||||
api: "openai-completions",
|
||||
models: [],
|
||||
})),
|
||||
);
|
||||
|
||||
vi.mock("./provider-catalog.js", () => ({
|
||||
buildHuggingfaceProvider: buildHuggingfaceProviderMock,
|
||||
}));
|
||||
|
||||
vi.mock("./onboard.js", () => ({
|
||||
applyHuggingfaceConfig: vi.fn((cfg) => cfg),
|
||||
HUGGINGFACE_DEFAULT_MODEL_REF: "huggingface/deepseek-ai/DeepSeek-R1",
|
||||
}));
|
||||
|
||||
import plugin from "./index.js";
|
||||
|
||||
function registerProvider() {
|
||||
return registerProviderWithPluginConfig({});
|
||||
}
|
||||
|
||||
function registerProviderWithPluginConfig(pluginConfig: Record<string, unknown>) {
|
||||
const registerProviderMock = vi.fn();
|
||||
|
||||
plugin.register(
|
||||
createTestPluginApi({
|
||||
id: "huggingface",
|
||||
name: "Hugging Face",
|
||||
source: "test",
|
||||
config: {},
|
||||
pluginConfig,
|
||||
runtime: {} as never,
|
||||
registerProvider: registerProviderMock,
|
||||
}),
|
||||
);
|
||||
|
||||
expect(registerProviderMock).toHaveBeenCalledTimes(1);
|
||||
const firstCall = registerProviderMock.mock.calls[0];
|
||||
if (!firstCall) {
|
||||
throw new Error("expected huggingface provider registration");
|
||||
}
|
||||
return firstCall[0];
|
||||
}
|
||||
|
||||
describe("huggingface plugin", () => {
|
||||
afterAll(() => {
|
||||
vi.doUnmock("./provider-catalog.js");
|
||||
vi.doUnmock("./onboard.js");
|
||||
vi.resetModules();
|
||||
});
|
||||
|
||||
it("skips catalog discovery when plugin discovery is disabled", async () => {
|
||||
const provider = registerProvider();
|
||||
|
||||
const result = await provider.catalog.run({
|
||||
config: {
|
||||
plugins: {
|
||||
entries: {
|
||||
huggingface: {
|
||||
config: {
|
||||
discovery: { enabled: false },
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
resolveProviderApiKey: () => ({
|
||||
apiKey: "hf_test_token",
|
||||
discoveryApiKey: "hf_test_token",
|
||||
}),
|
||||
} as never);
|
||||
|
||||
expect(result).toBeNull();
|
||||
expect(buildHuggingfaceProviderMock).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
60
extensions/huggingface/index.ts
Normal file
60
extensions/huggingface/index.ts
Normal file
@@ -0,0 +1,60 @@
|
||||
// Huggingface plugin entrypoint registers its OpenClaw integration.
|
||||
import { defineSingleProviderPluginEntry } from "openclaw/plugin-sdk/provider-entry";
|
||||
import { applyHuggingfaceConfig, HUGGINGFACE_DEFAULT_MODEL_REF } from "./onboard.js";
|
||||
import { buildHuggingfaceProvider } from "./provider-catalog.js";
|
||||
|
||||
const PROVIDER_ID = "huggingface";
|
||||
|
||||
type HuggingFacePluginConfig = {
|
||||
discovery?: {
|
||||
enabled?: boolean;
|
||||
};
|
||||
};
|
||||
|
||||
export default defineSingleProviderPluginEntry({
|
||||
id: PROVIDER_ID,
|
||||
name: "Hugging Face Provider",
|
||||
description: "Bundled Hugging Face provider plugin",
|
||||
provider: {
|
||||
label: "Hugging Face",
|
||||
docsPath: "/providers/huggingface",
|
||||
envVars: ["HUGGINGFACE_HUB_TOKEN", "HF_TOKEN"],
|
||||
auth: [
|
||||
{
|
||||
methodId: "api-key",
|
||||
label: "Hugging Face API key",
|
||||
hint: "Inference API (HF token)",
|
||||
optionKey: "huggingfaceApiKey",
|
||||
flagName: "--huggingface-api-key",
|
||||
envVar: "HUGGINGFACE_HUB_TOKEN",
|
||||
promptMessage: "Enter Hugging Face API key",
|
||||
defaultModel: HUGGINGFACE_DEFAULT_MODEL_REF,
|
||||
applyConfig: (cfg) => applyHuggingfaceConfig(cfg),
|
||||
},
|
||||
],
|
||||
catalog: {
|
||||
order: "simple",
|
||||
run: async (ctx) => {
|
||||
const pluginEntry = ctx.config?.plugins?.entries?.[PROVIDER_ID];
|
||||
const pluginConfig =
|
||||
pluginEntry && typeof pluginEntry === "object" && pluginEntry.config
|
||||
? (pluginEntry.config as HuggingFacePluginConfig)
|
||||
: undefined;
|
||||
const discoveryEnabled = pluginConfig?.discovery?.enabled;
|
||||
if (discoveryEnabled === false) {
|
||||
return null;
|
||||
}
|
||||
const { apiKey, discoveryApiKey } = ctx.resolveProviderApiKey(PROVIDER_ID);
|
||||
if (!apiKey) {
|
||||
return null;
|
||||
}
|
||||
return {
|
||||
provider: {
|
||||
...(await buildHuggingfaceProvider(discoveryApiKey)),
|
||||
apiKey,
|
||||
},
|
||||
};
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
6
extensions/huggingface/model-discovery-env.ts
Normal file
6
extensions/huggingface/model-discovery-env.ts
Normal file
@@ -0,0 +1,6 @@
|
||||
// Huggingface plugin module implements model discovery env behavior.
|
||||
export function isHuggingfaceModelDiscoveryTestEnvironment(
|
||||
env: Record<string, string | undefined> = process.env,
|
||||
): boolean {
|
||||
return env.VITEST === "true" || env.NODE_ENV === "test";
|
||||
}
|
||||
122
extensions/huggingface/models.test.ts
Normal file
122
extensions/huggingface/models.test.ts
Normal file
@@ -0,0 +1,122 @@
|
||||
// Huggingface tests cover models plugin behavior.
|
||||
import { MAX_TIMER_TIMEOUT_MS } from "openclaw/plugin-sdk/number-runtime";
|
||||
import { afterEach, describe, expect, it, vi } from "vitest";
|
||||
import {
|
||||
buildHuggingfaceModelDefinition,
|
||||
discoverHuggingfaceModels,
|
||||
HUGGINGFACE_MODEL_CATALOG,
|
||||
isHuggingfacePolicyLocked,
|
||||
} from "./api.js";
|
||||
import { HUGGINGFACE_DISCOVERY_TIMEOUT_MS } from "./models.js";
|
||||
|
||||
const ORIGINAL_VITEST = process.env.VITEST;
|
||||
const ORIGINAL_NODE_ENV = process.env.NODE_ENV;
|
||||
|
||||
function restoreEnv(key: "VITEST" | "NODE_ENV", value: string | undefined) {
|
||||
if (value === undefined) {
|
||||
delete process.env[key];
|
||||
} else {
|
||||
process.env[key] = value;
|
||||
}
|
||||
}
|
||||
|
||||
function stubAbortSignalTimeout() {
|
||||
const controller = new AbortController();
|
||||
return vi.spyOn(AbortSignal, "timeout").mockReturnValue(controller.signal);
|
||||
}
|
||||
|
||||
afterEach(() => {
|
||||
restoreEnv("VITEST", ORIGINAL_VITEST);
|
||||
restoreEnv("NODE_ENV", ORIGINAL_NODE_ENV);
|
||||
vi.restoreAllMocks();
|
||||
vi.unstubAllGlobals();
|
||||
});
|
||||
|
||||
describe("huggingface models", () => {
|
||||
it("buildHuggingfaceModelDefinition returns config with required fields", () => {
|
||||
const entry = HUGGINGFACE_MODEL_CATALOG[0];
|
||||
const def = buildHuggingfaceModelDefinition(entry);
|
||||
expect(def.id).toBe(entry.id);
|
||||
expect(def.name).toBe(entry.name);
|
||||
expect(def.reasoning).toBe(entry.reasoning);
|
||||
expect(def.input).toEqual(entry.input);
|
||||
expect(def.cost).toEqual(entry.cost);
|
||||
expect(def.contextWindow).toBe(entry.contextWindow);
|
||||
expect(def.maxTokens).toBe(entry.maxTokens);
|
||||
});
|
||||
|
||||
it("discoverHuggingfaceModels returns static catalog when apiKey is empty", async () => {
|
||||
const models = await discoverHuggingfaceModels("");
|
||||
expect(models).toHaveLength(HUGGINGFACE_MODEL_CATALOG.length);
|
||||
expect(models.map((m) => m.id)).toEqual(HUGGINGFACE_MODEL_CATALOG.map((m) => m.id));
|
||||
});
|
||||
|
||||
it("discoverHuggingfaceModels returns static catalog in test env (VITEST)", async () => {
|
||||
const models = await discoverHuggingfaceModels("hf_test_token");
|
||||
expect(models).toHaveLength(HUGGINGFACE_MODEL_CATALOG.length);
|
||||
expect(models[0].id).toBe("deepseek-ai/DeepSeek-R1");
|
||||
});
|
||||
|
||||
it("uses the default discovery timeout for live Hugging Face fetches", async () => {
|
||||
process.env.VITEST = "false";
|
||||
process.env.NODE_ENV = "development";
|
||||
const timeoutSpy = stubAbortSignalTimeout();
|
||||
vi.stubGlobal(
|
||||
"fetch",
|
||||
vi.fn(
|
||||
async () =>
|
||||
new Response("{}", { status: 500, headers: { "Content-Type": "application/json" } }),
|
||||
),
|
||||
);
|
||||
|
||||
await discoverHuggingfaceModels("hf_test_token");
|
||||
|
||||
expect(timeoutSpy).toHaveBeenCalledWith(HUGGINGFACE_DISCOVERY_TIMEOUT_MS);
|
||||
});
|
||||
|
||||
it("accepts a custom discovery timeout override", async () => {
|
||||
process.env.VITEST = "false";
|
||||
process.env.NODE_ENV = "development";
|
||||
const timeoutSpy = stubAbortSignalTimeout();
|
||||
vi.stubGlobal(
|
||||
"fetch",
|
||||
vi.fn(
|
||||
async () =>
|
||||
new Response("{}", { status: 500, headers: { "Content-Type": "application/json" } }),
|
||||
),
|
||||
);
|
||||
|
||||
await discoverHuggingfaceModels("hf_test_token", 25_000);
|
||||
|
||||
expect(timeoutSpy).toHaveBeenCalledWith(25_000);
|
||||
});
|
||||
|
||||
it("caps oversized live discovery timeout overrides", async () => {
|
||||
process.env.VITEST = "false";
|
||||
process.env.NODE_ENV = "development";
|
||||
const timeoutSpy = stubAbortSignalTimeout();
|
||||
vi.stubGlobal(
|
||||
"fetch",
|
||||
vi.fn(
|
||||
async () =>
|
||||
new Response("{}", { status: 500, headers: { "Content-Type": "application/json" } }),
|
||||
),
|
||||
);
|
||||
|
||||
await discoverHuggingfaceModels("hf_test_token", Number.MAX_SAFE_INTEGER);
|
||||
|
||||
expect(timeoutSpy).toHaveBeenCalledWith(MAX_TIMER_TIMEOUT_MS);
|
||||
});
|
||||
|
||||
describe("isHuggingfacePolicyLocked", () => {
|
||||
it("returns true for :cheapest and :fastest refs", () => {
|
||||
expect(isHuggingfacePolicyLocked("huggingface/deepseek-ai/DeepSeek-R1:cheapest")).toBe(true);
|
||||
expect(isHuggingfacePolicyLocked("huggingface/deepseek-ai/DeepSeek-R1:fastest")).toBe(true);
|
||||
});
|
||||
|
||||
it("returns false for base ref and :provider refs", () => {
|
||||
expect(isHuggingfacePolicyLocked("huggingface/deepseek-ai/DeepSeek-R1")).toBe(false);
|
||||
expect(isHuggingfacePolicyLocked("huggingface/foo:together")).toBe(false);
|
||||
});
|
||||
});
|
||||
});
|
||||
222
extensions/huggingface/models.ts
Normal file
222
extensions/huggingface/models.ts
Normal file
@@ -0,0 +1,222 @@
|
||||
// Huggingface plugin module implements models behavior.
|
||||
import { resolveTimerTimeoutMs } from "openclaw/plugin-sdk/number-runtime";
|
||||
import type { ModelDefinitionConfig } from "openclaw/plugin-sdk/provider-model-types";
|
||||
import {
|
||||
fetchWithSsrFGuard,
|
||||
ssrfPolicyFromHttpBaseUrlAllowedHostname,
|
||||
} from "openclaw/plugin-sdk/ssrf-runtime";
|
||||
import { normalizeLowercaseStringOrEmpty } from "openclaw/plugin-sdk/string-coerce-runtime";
|
||||
import { isHuggingfaceModelDiscoveryTestEnvironment } from "./model-discovery-env.js";
|
||||
|
||||
export const HUGGINGFACE_BASE_URL = "https://router.huggingface.co/v1";
|
||||
export const HUGGINGFACE_POLICY_SUFFIXES = ["cheapest", "fastest"] as const;
|
||||
export const HUGGINGFACE_DISCOVERY_TIMEOUT_MS = 30_000;
|
||||
|
||||
const HUGGINGFACE_DEFAULT_COST = {
|
||||
input: 0,
|
||||
output: 0,
|
||||
cacheRead: 0,
|
||||
cacheWrite: 0,
|
||||
};
|
||||
|
||||
const HUGGINGFACE_DEFAULT_CONTEXT_WINDOW = 131072;
|
||||
const HUGGINGFACE_DEFAULT_MAX_TOKENS = 8192;
|
||||
|
||||
type HFModelEntry = {
|
||||
id: string;
|
||||
owned_by?: string;
|
||||
name?: string;
|
||||
title?: string;
|
||||
display_name?: string;
|
||||
architecture?: {
|
||||
input_modalities?: string[];
|
||||
};
|
||||
providers?: Array<{
|
||||
context_length?: number;
|
||||
}>;
|
||||
};
|
||||
|
||||
type OpenAIListModelsResponse = {
|
||||
data?: HFModelEntry[];
|
||||
};
|
||||
|
||||
export const HUGGINGFACE_MODEL_CATALOG: ModelDefinitionConfig[] = [
|
||||
{
|
||||
id: "deepseek-ai/DeepSeek-R1",
|
||||
name: "DeepSeek R1",
|
||||
reasoning: true,
|
||||
input: ["text"],
|
||||
contextWindow: 131072,
|
||||
maxTokens: 8192,
|
||||
cost: { input: 3, output: 7, cacheRead: 3, cacheWrite: 3 },
|
||||
},
|
||||
{
|
||||
id: "deepseek-ai/DeepSeek-V3.1",
|
||||
name: "DeepSeek V3.1",
|
||||
reasoning: false,
|
||||
input: ["text"],
|
||||
contextWindow: 131072,
|
||||
maxTokens: 8192,
|
||||
cost: { input: 0.6, output: 1.25, cacheRead: 0.6, cacheWrite: 0.6 },
|
||||
},
|
||||
{
|
||||
id: "meta-llama/Llama-3.3-70B-Instruct-Turbo",
|
||||
name: "Llama 3.3 70B Instruct Turbo",
|
||||
reasoning: false,
|
||||
input: ["text"],
|
||||
contextWindow: 131072,
|
||||
maxTokens: 8192,
|
||||
cost: { input: 0.88, output: 0.88, cacheRead: 0.88, cacheWrite: 0.88 },
|
||||
},
|
||||
{
|
||||
id: "openai/gpt-oss-120b",
|
||||
name: "GPT-OSS 120B",
|
||||
reasoning: false,
|
||||
input: ["text"],
|
||||
contextWindow: 131072,
|
||||
maxTokens: 8192,
|
||||
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
|
||||
},
|
||||
];
|
||||
|
||||
export function isHuggingfacePolicyLocked(modelRef: string): boolean {
|
||||
const ref = modelRef.trim();
|
||||
return HUGGINGFACE_POLICY_SUFFIXES.some((suffix) => ref.endsWith(`:${suffix}`) || ref === suffix);
|
||||
}
|
||||
|
||||
export function buildHuggingfaceModelDefinition(
|
||||
model: (typeof HUGGINGFACE_MODEL_CATALOG)[number],
|
||||
): ModelDefinitionConfig {
|
||||
return {
|
||||
id: model.id,
|
||||
name: model.name,
|
||||
reasoning: model.reasoning,
|
||||
input: model.input,
|
||||
cost: model.cost,
|
||||
contextWindow: model.contextWindow,
|
||||
maxTokens: model.maxTokens,
|
||||
};
|
||||
}
|
||||
|
||||
function isReasoningModelHeuristic(modelId: string): boolean {
|
||||
const lower = normalizeLowercaseStringOrEmpty(modelId);
|
||||
return (
|
||||
lower.includes("r1") ||
|
||||
lower.includes("reason") ||
|
||||
lower.includes("thinking") ||
|
||||
lower.includes("reasoner") ||
|
||||
lower.includes("grok") ||
|
||||
lower.includes("qwq")
|
||||
);
|
||||
}
|
||||
|
||||
function inferredMetaFromModelId(id: string): { name: string; reasoning: boolean } {
|
||||
const base = id.split("/").pop() ?? id;
|
||||
const reasoning = isReasoningModelHeuristic(id);
|
||||
const name = base.replace(/-/g, " ").replace(/\b(\w)/g, (c) => c.toUpperCase());
|
||||
return { name, reasoning };
|
||||
}
|
||||
|
||||
function displayNameFromApiEntry(entry: HFModelEntry, inferredName: string): string {
|
||||
const fromApi =
|
||||
(typeof entry.name === "string" && entry.name.trim()) ||
|
||||
(typeof entry.title === "string" && entry.title.trim()) ||
|
||||
(typeof entry.display_name === "string" && entry.display_name.trim());
|
||||
if (fromApi) {
|
||||
return fromApi;
|
||||
}
|
||||
if (typeof entry.owned_by === "string" && entry.owned_by.trim()) {
|
||||
const base = entry.id.split("/").pop() ?? entry.id;
|
||||
return `${entry.owned_by.trim()}/${base}`;
|
||||
}
|
||||
return inferredName;
|
||||
}
|
||||
|
||||
export async function discoverHuggingfaceModels(
|
||||
apiKey: string,
|
||||
timeoutMs = HUGGINGFACE_DISCOVERY_TIMEOUT_MS,
|
||||
): Promise<ModelDefinitionConfig[]> {
|
||||
if (isHuggingfaceModelDiscoveryTestEnvironment()) {
|
||||
return HUGGINGFACE_MODEL_CATALOG.map(buildHuggingfaceModelDefinition);
|
||||
}
|
||||
|
||||
const trimmedKey = apiKey?.trim();
|
||||
if (!trimmedKey) {
|
||||
return HUGGINGFACE_MODEL_CATALOG.map(buildHuggingfaceModelDefinition);
|
||||
}
|
||||
|
||||
try {
|
||||
const requestTimeoutMs = resolveTimerTimeoutMs(timeoutMs, HUGGINGFACE_DISCOVERY_TIMEOUT_MS);
|
||||
const { response, release } = await fetchWithSsrFGuard({
|
||||
url: `${HUGGINGFACE_BASE_URL}/models`,
|
||||
init: {
|
||||
signal: AbortSignal.timeout(requestTimeoutMs),
|
||||
headers: {
|
||||
Authorization: `Bearer ${trimmedKey}`,
|
||||
"Content-Type": "application/json",
|
||||
},
|
||||
},
|
||||
timeoutMs: requestTimeoutMs,
|
||||
policy: ssrfPolicyFromHttpBaseUrlAllowedHostname(HUGGINGFACE_BASE_URL),
|
||||
auditContext: "huggingface-model-discovery",
|
||||
});
|
||||
try {
|
||||
if (!response.ok) {
|
||||
return HUGGINGFACE_MODEL_CATALOG.map(buildHuggingfaceModelDefinition);
|
||||
}
|
||||
|
||||
const body = (await response.json()) as OpenAIListModelsResponse;
|
||||
const data = body?.data;
|
||||
if (!Array.isArray(data) || data.length === 0) {
|
||||
return HUGGINGFACE_MODEL_CATALOG.map(buildHuggingfaceModelDefinition);
|
||||
}
|
||||
|
||||
const catalogById = new Map(
|
||||
HUGGINGFACE_MODEL_CATALOG.map((model) => [model.id, model] as const),
|
||||
);
|
||||
const seen = new Set<string>();
|
||||
const models: ModelDefinitionConfig[] = [];
|
||||
|
||||
for (const entry of data) {
|
||||
const id = typeof entry?.id === "string" ? entry.id.trim() : "";
|
||||
if (!id || seen.has(id)) {
|
||||
continue;
|
||||
}
|
||||
seen.add(id);
|
||||
|
||||
const catalogEntry = catalogById.get(id);
|
||||
if (catalogEntry) {
|
||||
models.push(buildHuggingfaceModelDefinition(catalogEntry));
|
||||
continue;
|
||||
}
|
||||
|
||||
const inferred = inferredMetaFromModelId(id);
|
||||
const name = displayNameFromApiEntry(entry, inferred.name);
|
||||
const modalities = entry.architecture?.input_modalities;
|
||||
const input: Array<"text" | "image"> =
|
||||
Array.isArray(modalities) && modalities.includes("image") ? ["text", "image"] : ["text"];
|
||||
const providers = Array.isArray(entry.providers) ? entry.providers : [];
|
||||
const providerWithContext = providers.find(
|
||||
(provider) => typeof provider?.context_length === "number" && provider.context_length > 0,
|
||||
);
|
||||
models.push({
|
||||
id,
|
||||
name,
|
||||
reasoning: inferred.reasoning,
|
||||
input,
|
||||
cost: HUGGINGFACE_DEFAULT_COST,
|
||||
contextWindow: providerWithContext?.context_length ?? HUGGINGFACE_DEFAULT_CONTEXT_WINDOW,
|
||||
maxTokens: HUGGINGFACE_DEFAULT_MAX_TOKENS,
|
||||
});
|
||||
}
|
||||
|
||||
return models.length > 0
|
||||
? models
|
||||
: HUGGINGFACE_MODEL_CATALOG.map(buildHuggingfaceModelDefinition);
|
||||
} finally {
|
||||
await release();
|
||||
}
|
||||
} catch {
|
||||
return HUGGINGFACE_MODEL_CATALOG.map(buildHuggingfaceModelDefinition);
|
||||
}
|
||||
}
|
||||
27
extensions/huggingface/onboard.ts
Normal file
27
extensions/huggingface/onboard.ts
Normal file
@@ -0,0 +1,27 @@
|
||||
// Huggingface setup module handles plugin onboarding behavior.
|
||||
import {
|
||||
createModelCatalogPresetAppliers,
|
||||
type OpenClawConfig,
|
||||
} from "openclaw/plugin-sdk/provider-onboard";
|
||||
import {
|
||||
buildHuggingfaceModelDefinition,
|
||||
HUGGINGFACE_BASE_URL,
|
||||
HUGGINGFACE_MODEL_CATALOG,
|
||||
} from "./models.js";
|
||||
|
||||
export const HUGGINGFACE_DEFAULT_MODEL_REF = "huggingface/deepseek-ai/DeepSeek-R1";
|
||||
|
||||
const huggingfacePresetAppliers = createModelCatalogPresetAppliers({
|
||||
primaryModelRef: HUGGINGFACE_DEFAULT_MODEL_REF,
|
||||
resolveParams: (_cfg: OpenClawConfig) => ({
|
||||
providerId: "huggingface",
|
||||
api: "openai-completions",
|
||||
baseUrl: HUGGINGFACE_BASE_URL,
|
||||
catalogModels: HUGGINGFACE_MODEL_CATALOG.map(buildHuggingfaceModelDefinition),
|
||||
aliases: [{ modelRef: HUGGINGFACE_DEFAULT_MODEL_REF, alias: "Hugging Face" }],
|
||||
}),
|
||||
});
|
||||
|
||||
export function applyHuggingfaceConfig(cfg: OpenClawConfig): OpenClawConfig {
|
||||
return huggingfacePresetAppliers.applyConfig(cfg);
|
||||
}
|
||||
63
extensions/huggingface/openclaw.plugin.json
Normal file
63
extensions/huggingface/openclaw.plugin.json
Normal file
@@ -0,0 +1,63 @@
|
||||
{
|
||||
"id": "huggingface",
|
||||
"icon": "https://cdn.simpleicons.org/huggingface",
|
||||
"activation": {
|
||||
"onStartup": false
|
||||
},
|
||||
"enabledByDefault": true,
|
||||
"providers": ["huggingface"],
|
||||
"modelIdNormalization": {
|
||||
"providers": {
|
||||
"huggingface": {
|
||||
"stripPrefixes": ["huggingface/"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"setup": {
|
||||
"providers": [
|
||||
{
|
||||
"id": "huggingface",
|
||||
"envVars": ["HUGGINGFACE_HUB_TOKEN", "HF_TOKEN"]
|
||||
}
|
||||
]
|
||||
},
|
||||
"providerAuthChoices": [
|
||||
{
|
||||
"provider": "huggingface",
|
||||
"method": "api-key",
|
||||
"choiceId": "huggingface-api-key",
|
||||
"choiceLabel": "Hugging Face API key",
|
||||
"choiceHint": "Inference API (HF token)",
|
||||
"groupId": "huggingface",
|
||||
"groupLabel": "Hugging Face",
|
||||
"groupHint": "Inference API (HF token)",
|
||||
"optionKey": "huggingfaceApiKey",
|
||||
"cliFlag": "--huggingface-api-key",
|
||||
"cliOption": "--huggingface-api-key <key>",
|
||||
"cliDescription": "Hugging Face API key (HF token)"
|
||||
}
|
||||
],
|
||||
"configSchema": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"discovery": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": { "type": "boolean" }
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"uiHints": {
|
||||
"discovery": {
|
||||
"label": "Model Discovery",
|
||||
"help": "Plugin-owned controls for Hugging Face model auto-discovery."
|
||||
},
|
||||
"discovery.enabled": {
|
||||
"label": "Enable Discovery",
|
||||
"help": "When false, OpenClaw keeps the Hugging Face plugin available but skips implicit startup discovery from ambient Hugging Face credentials."
|
||||
}
|
||||
}
|
||||
}
|
||||
15
extensions/huggingface/package.json
Normal file
15
extensions/huggingface/package.json
Normal file
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"name": "@openclaw/huggingface-provider",
|
||||
"version": "2026.6.11",
|
||||
"private": true,
|
||||
"description": "OpenClaw Hugging Face provider plugin",
|
||||
"type": "module",
|
||||
"devDependencies": {
|
||||
"@openclaw/plugin-sdk": "workspace:*"
|
||||
},
|
||||
"openclaw": {
|
||||
"extensions": [
|
||||
"./index.ts"
|
||||
]
|
||||
}
|
||||
}
|
||||
23
extensions/huggingface/provider-catalog.ts
Normal file
23
extensions/huggingface/provider-catalog.ts
Normal file
@@ -0,0 +1,23 @@
|
||||
// Huggingface provider module implements model/runtime integration.
|
||||
import type { ModelProviderConfig } from "openclaw/plugin-sdk/provider-model-types";
|
||||
import {
|
||||
buildHuggingfaceModelDefinition,
|
||||
discoverHuggingfaceModels,
|
||||
HUGGINGFACE_BASE_URL,
|
||||
HUGGINGFACE_MODEL_CATALOG,
|
||||
} from "./models.js";
|
||||
|
||||
export async function buildHuggingfaceProvider(
|
||||
discoveryApiKey?: string,
|
||||
): Promise<ModelProviderConfig> {
|
||||
const resolvedSecret = discoveryApiKey?.trim() ?? "";
|
||||
const models =
|
||||
resolvedSecret !== ""
|
||||
? await discoverHuggingfaceModels(resolvedSecret)
|
||||
: HUGGINGFACE_MODEL_CATALOG.map(buildHuggingfaceModelDefinition);
|
||||
return {
|
||||
baseUrl: HUGGINGFACE_BASE_URL,
|
||||
api: "openai-completions",
|
||||
models,
|
||||
};
|
||||
}
|
||||
16
extensions/huggingface/tsconfig.json
Normal file
16
extensions/huggingface/tsconfig.json
Normal file
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"extends": "../tsconfig.package-boundary.base.json",
|
||||
"compilerOptions": {
|
||||
"rootDir": "."
|
||||
},
|
||||
"include": ["./*.ts", "./src/**/*.ts"],
|
||||
"exclude": [
|
||||
"./**/*.test.ts",
|
||||
"./dist/**",
|
||||
"./node_modules/**",
|
||||
"./src/test-support/**",
|
||||
"./src/**/*test-helpers.ts",
|
||||
"./src/**/*test-harness.ts",
|
||||
"./src/**/*test-support.ts"
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user