ake/paperclip
1
0
Fork 0
mirror of https://github.com/alkimake/paperclip.git synced 2026-06-14 01:50:39 +09:00
Code Issues Projects Releases Packages Wiki Activity

feat(adapters): declarative config-schema API and UI for plugin adapters

Browse source 
Cherry-picked from feat/externalize-hermes-adapter.
Resolved conflicts: kept Hermes as built-in on phase1 branch.
This commit is contained in:
HenkDz 2026-04-01 13:58:02 +01:00
parent f884cbab78
commit 69a1593ff8
8 changed files with 392 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

3
packages/adapter-utils/src/index.ts
View file

@ -22,6 +22,9 @@ export type {
AdapterModel,
HireApprovedPayload,
HireApprovedHookResult,
ConfigFieldOption,
ConfigFieldSchema,
AdapterConfigSchema,
ServerAdapterModule,
QuotaWindow,
ProviderQuotaResult,

33
packages/adapter-utils/src/types.ts
View file

@ -261,6 +261,30 @@ export interface ProviderQuotaResult {
windows: QuotaWindow[];
}
// ---------------------------------------------------------------------------
// Adapter config schema — declarative UI config for external adapters
// ---------------------------------------------------------------------------
export interface ConfigFieldOption {
label: string;
value: string;
}
export interface ConfigFieldSchema {
key: string;
label: string;
type: "text" | "select" | "toggle" | "number" | "textarea";
options?: ConfigFieldOption[];
default?: unknown;
hint?: string;
required?: boolean;
group?: string;
}
export interface AdapterConfigSchema {
fields: ConfigFieldSchema[];
}
export interface ServerAdapterModule {
type: string;
execute(ctx: AdapterExecutionContext): Promise<AdapterExecutionResult>;
@ -293,6 +317,13 @@ export interface ServerAdapterModule {
* the adapter does not support detection or no config is found.
*/
detectModel?: () => Promise<{ model: string; provider: string; source: string; candidates?: string[] } | null>;
/**
* Optional: return a declarative config schema so the UI can render
* adapter-specific form fields without shipping React components.
* Dynamic options (e.g. scanning a profiles directory) should be
* resolved inside this method — the caller receives a fully hydrated schema.
*/
getConfigSchema?: () => Promise<AdapterConfigSchema> | AdapterConfigSchema;
}
// ---------------------------------------------------------------------------
@ -353,4 +384,6 @@ export interface CreateConfigValues {
maxTurnsPerRun: number;
heartbeatEnabled: boolean;
intervalSec: number;
/** Arbitrary key-value pairs populated by schema-driven config fields. */
adapterSchemaValues?: Record<string, unknown>;
}